From 7e6c6f20f32281b0f13459cd45741023f6e65677 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Thu, 23 Nov 2023 05:17:57 +0000 Subject: [PATCH] docs: updated workflow docs --- docs/image_build_multi.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/image_build_multi.md b/docs/image_build_multi.md index 0746e9f..84f8fd0 100644 --- a/docs/image_build_multi.md +++ b/docs/image_build_multi.md @@ -12,10 +12,43 @@ Supports: ## Inputs + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| -------------------------------------------------------------------------------- | ------- | -------- | -------------- | --------------------------------------------------------------------------------------------- | +| [build_target](#input_build_target) | string | false | | The target to built to
(default to end of the Dockerfile). | +| [cache](#input_cache) | boolean | false | `true` | Use GHCR caching. Default true.
Set this false if registry
is not ghcr.io. | +| [context](#input_context) | string | false | `"."` | Root directory to start the
build from. | +| [dockerfile](#input_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to
context dir. | +| [extra_build_args](#input_extra_build_args) | string | false | | Space separated list of extra
build args to use for
the image. | +| [image_name](#input_image_name) | string | false | | Name of image, without tags.
Not required if image_tags specified. | +| [image_tags](#input_image_tags) | string | false | | Default=the images are automatically tagged.
Override tags with space separated
list. | +| [push](#input_push) | boolean | false | `true` | Override prevent pushing the image. | +| [registry](#input_registry) | string | false | `"ghcr.io"` | Override GHCR to use an
external reg. | +| [scan_dockerfile](#input_scan_dockerfile) | boolean | false | `true` | Enable dockerfile vulnerability scanning, prior
to build. | +| [scan_image](#input_scan_image) | boolean | false | `true` | Enable image vulnerability scan, after
build. | + + + ## Secrets + + +No secrets. + + + ## Outputs + + +| OUTPUT | VALUE | DESCRIPTION | +| ---------------------------------------------------------------- | ----------------------------------------------- | ------------------------------- | +| [image_name](#output_image_name) | `"${{ jobs.build-images.outputs.image_name }}"` | The final full image reference. | +| [image_tag](#output_image_tag) | `"${{ jobs.build-images.outputs.image_tag }}"` | The final image tag. | + + + ## Example Usage ```yaml