From f39d2b2a022062a7aae161a3f6942395aec5d123 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 6 Jun 2023 12:29:17 +0000 Subject: [PATCH] docs: update readme with autodoc --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 734a656..96139c0 100644 --- a/README.md +++ b/README.md @@ -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.