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] authored and stigok committed Jun 15, 2023
1 parent 14b34c1 commit f24599a
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 @@ -27,6 +27,7 @@ jobs:
### Inputs
- `context` (string, default `"."`) - The root directory for the Docker build context.
- `dockerfile` (string, default `"Dockerfile"`) - Path to a Dockerfile relative to the Docker build context path.
- `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.
- `tag-branch` (boolean, default `false`) - Tag a successfully built image with the branch name.
Expand All @@ -43,6 +44,7 @@ jobs:
- `trivy-summary-enabled` (boolean, default `false`) - Render a table of all the Trivy findings in the GitHub summary for the workflow.

### Secrets
- `git-ssh-key` - SSH key used by Git to checkout the repository.
- `registry-username` (**required**) - Username for the container registry.
- `registry-password` (**required**) - Password for the container registry.
- `token` (**required**) - GitHub auth token.
Expand Down

0 comments on commit f24599a

Please sign in to comment.