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 bateau84 committed Jun 5, 2023
1 parent 5fb083a commit 7ce27e5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ jobs:
- `push` (boolean, default `true`) - Push a successfully built image to a registry.
- `name` (string, **required**) - Image name (repository path) within a registry.
- `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.
- `trivy-enabled` (boolean, default `true`) - Scan the built image for known vulnerabilities using Trivy.
- `trivy-error-is-success` (boolean, default `false`) - Do not produce an error if the Trivy scan fails. Primarily used for testing.
Expand All @@ -38,7 +39,6 @@ jobs:
- `trivy-severity` (string, default `"MEDIUM,HIGH,CRITICAL"`) - Comma-separated list of severities to consider an error.

### Secrets
- `registry-url` (**required**) - URL to the container registry.
- `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 7ce27e5

Please sign in to comment.