docs: update readme with autodoc

README.md

@@ -24,6 +24,30 @@ jobs:
 ```
 
 <!-- autodoc start -->
+### 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.
+- `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.
+- `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.
+- `trivy-ignore-unfixed` (boolean, default `true`) - Ignore errors that do not have a known fix.
+- `trivy-ignore-files` (string, default `""`) - Comma-separated list of paths to Trivy ignore files, relative to the repository root.
+- `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.
+
+### Outputs
+- `image-digest` - The image digest for this build.
+- `image-ref-stripped` - An image reference for this build, stripped of its registry URL ("<name>:<sha>@<digest>").
+- `image-tags-stripped` - Comma-separated list of generated image tags for this build, stripped of their registry URL, without a leading slash (i.e. "<name1>:<tag1>,<name2>:<tag2>").
+- `unique-id` - A generated unique ID for this run. Can be useful when debugging runners to determine artifact filenames.
 <!-- autodoc end -->
 
 ## Implementation notes