Skip to content

Commit

Permalink
docs: update readme with autodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 13, 2025
1 parent 57fbf97 commit 29cc5ee
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ jobs:
- `git-submodules` (boolean, default `false`) - Whether to also checkout Git submodules.
- `push` (boolean, default `true`) - Push a successfully built image to a registry.
- `name` (string, **required**) - Image name (repository path) within a registry.
- `ssh-agent` (boolean, default `false`) - Whether to start an SSH agent for the build.
- `tag-branch` (boolean, default `false`) - Tag a successfully built image with the branch name.
- `tag-sha` (boolean, default `true`) - Tag a successfully built image with the commit SHA that triggered the workflow.
- `tag-pr` (boolean, default `true`) - Tag a successfully built image with reference to a Pull Request, e.g. pr-2.
Expand All @@ -53,6 +54,7 @@ jobs:
- `registry-username` (**required**) - Username for the container registry.
- `registry-password` (**required**) - Password for the container registry.
- `token` (**required**) - GitHub auth token.
- `ssh-deploy-key` - SSH key to load in the SSH agent

### Outputs
- `image-digest` - The image digest for this build.
Expand Down

0 comments on commit 29cc5ee

Please sign in to comment.