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 @siljekristensen
github-actions[bot] authored and siljekristensen committed Jun 6, 2023
1 parent 77ccc66 commit f39d2b2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ jobs:
- `dockerfile` (string, default `"Dockerfile"`) - Path to a Dockerfile relative to the Docker build context path.
- `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.
- `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.
- `tag-latest` (boolean, default `false`) - Tag a successfully built image with the tag latest.
- `registry-url` (string, **required**) - URL to the container registry.
- `runs-on` (string, default `"['self-hosted']"`) - Type of runner for the jobs. For non-self-hosted runners, use ubuntu-latest for example.
Expand Down

0 comments on commit f39d2b2

Please sign in to comment.