From 1ccb57f1f4ef8b884b6495f787f4374a6c31ab71 Mon Sep 17 00:00:00 2001
From: spwoodcock <78538841+spwoodcock@users.noreply.github.com>
Date: Tue, 12 Nov 2024 18:00:45 +0000
Subject: [PATCH] docs: updated workflow docs
---
docs/image_build.md | 29 +++++++++++++++--------------
docs/image_build_multi.md | 27 ++++++++++++++-------------
2 files changed, 29 insertions(+), 27 deletions(-)
diff --git a/docs/image_build.md b/docs/image_build.md
index c9581d4..4df4be5 100644
--- a/docs/image_build.md
+++ b/docs/image_build.md
@@ -85,20 +85,21 @@ and should be faster (amd64 | arm/v6 | arm/v7 | arm64).
-| 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. |
-| [multi_arch](#input_multi_arch) | boolean | false | `false` | Build a multi-arch image for
AMD64/ARM64. |
-| [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. |
+| 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. |
+| [multi_arch](#input_multi_arch) | boolean | false | `false` | Build a multi-arch image for
AMD64/ARM64. |
+| [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. |
+| [skip_cve](#input_skip_cve) | string | false | `"CKV_DOCKER_8,CKV_DOCKER_2,CKV_DOCKER_3,CKV_DOCKER_5"` | Skip specific CVE from checkcov
(override rules). |
diff --git a/docs/image_build_multi.md b/docs/image_build_multi.md
index 84f8fd0..ea35942 100644
--- a/docs/image_build_multi.md
+++ b/docs/image_build_multi.md
@@ -14,19 +14,20 @@ Supports:
-| 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. |
+| 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. |
+| [skip_cve](#input_skip_cve) | string | false | `"CKV_DOCKER_8,CKV_DOCKER_2,CKV_DOCKER_3,CKV_DOCKER_5"` | Skip specific CVE from checkcov
(override rules). |