Skip to content

Commit

Permalink
Merge pull request #58 from hotosm/docs/auto-doc-update-workflows
Browse files Browse the repository at this point in the history 
auto-doc: updated workflows docs
  • Loading branch information
@spwoodcock
spwoodcock authored Nov 12, 2024
2 parents b6f7fbf + 1ccb57f commit 2849199
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 27 deletions.
29 changes: 15 additions & 14 deletions docs/image_build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,20 +85,21 @@ and should be faster (amd64 | arm/v6 | arm/v7 | arm64).

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | -------------- | --------------------------------------------------------------------------------------------- |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | | The target to built to <br>(default to end of the Dockerfile). |
| <a name="input_cache"></a>[cache](#input_cache) | boolean | false | `true` | Use GHCR caching. Default true. <br>Set this false if registry <br>is not ghcr.io. |
| <a name="input_context"></a>[context](#input_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_dockerfile"></a>[dockerfile](#input_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of extra <br>build args to use for <br>the image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | false | | Name of image, without tags. <br>Not required if image_tags specified. |
| <a name="input_image_tags"></a>[image_tags](#input_image_tags) | string | false | | Default=the images are automatically tagged. <br>Override tags with space separated <br>list. |
| <a name="input_multi_arch"></a>[multi_arch](#input_multi_arch) | boolean | false | `false` | Build a multi-arch image for <br>AMD64/ARM64. |
| <a name="input_push"></a>[push](#input_push) | boolean | false | `true` | Override prevent pushing the image. |
| <a name="input_registry"></a>[registry](#input_registry) | string | false | `"ghcr.io"` | Override GHCR to use an <br>external reg. |
| <a name="input_scan_dockerfile"></a>[scan_dockerfile](#input_scan_dockerfile) | boolean | false | `true` | Enable dockerfile vulnerability scanning, prior <br>to build. |
| <a name="input_scan_image"></a>[scan_image](#input_scan_image) | boolean | false | `true` | Enable image vulnerability scan, after <br>build. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | | The target to built to <br>(default to end of the Dockerfile). |
| <a name="input_cache"></a>[cache](#input_cache) | boolean | false | `true` | Use GHCR caching. Default true. <br>Set this false if registry <br>is not ghcr.io. |
| <a name="input_context"></a>[context](#input_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_dockerfile"></a>[dockerfile](#input_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of extra <br>build args to use for <br>the image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | false | | Name of image, without tags. <br>Not required if image_tags specified. |
| <a name="input_image_tags"></a>[image_tags](#input_image_tags) | string | false | | Default=the images are automatically tagged. <br>Override tags with space separated <br>list. |
| <a name="input_multi_arch"></a>[multi_arch](#input_multi_arch) | boolean | false | `false` | Build a multi-arch image for <br>AMD64/ARM64. |
| <a name="input_push"></a>[push](#input_push) | boolean | false | `true` | Override prevent pushing the image. |
| <a name="input_registry"></a>[registry](#input_registry) | string | false | `"ghcr.io"` | Override GHCR to use an <br>external reg. |
| <a name="input_scan_dockerfile"></a>[scan_dockerfile](#input_scan_dockerfile) | boolean | false | `true` | Enable dockerfile vulnerability scanning, prior <br>to build. |
| <a name="input_scan_image"></a>[scan_image](#input_scan_image) | boolean | false | `true` | Enable image vulnerability scan, after <br>build. |
| <a name="input_skip_cve"></a>[skip_cve](#input_skip_cve) | string | false | `"CKV_DOCKER_8,CKV_DOCKER_2,CKV_DOCKER_3,CKV_DOCKER_5"` | Skip specific CVE from checkcov <br>(override rules). |

<!-- AUTO-DOC-INPUT:END -->

Expand Down
27 changes: 14 additions & 13 deletions docs/image_build_multi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ Supports:

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | -------------- | --------------------------------------------------------------------------------------------- |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | | The target to built to <br>(default to end of the Dockerfile). |
| <a name="input_cache"></a>[cache](#input_cache) | boolean | false | `true` | Use GHCR caching. Default true. <br>Set this false if registry <br>is not ghcr.io. |
| <a name="input_context"></a>[context](#input_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_dockerfile"></a>[dockerfile](#input_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of extra <br>build args to use for <br>the image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | false | | Name of image, without tags. <br>Not required if image_tags specified. |
| <a name="input_image_tags"></a>[image_tags](#input_image_tags) | string | false | | Default=the images are automatically tagged. <br>Override tags with space separated <br>list. |
| <a name="input_push"></a>[push](#input_push) | boolean | false | `true` | Override prevent pushing the image. |
| <a name="input_registry"></a>[registry](#input_registry) | string | false | `"ghcr.io"` | Override GHCR to use an <br>external reg. |
| <a name="input_scan_dockerfile"></a>[scan_dockerfile](#input_scan_dockerfile) | boolean | false | `true` | Enable dockerfile vulnerability scanning, prior <br>to build. |
| <a name="input_scan_image"></a>[scan_image](#input_scan_image) | boolean | false | `true` | Enable image vulnerability scan, after <br>build. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | | The target to built to <br>(default to end of the Dockerfile). |
| <a name="input_cache"></a>[cache](#input_cache) | boolean | false | `true` | Use GHCR caching. Default true. <br>Set this false if registry <br>is not ghcr.io. |
| <a name="input_context"></a>[context](#input_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_dockerfile"></a>[dockerfile](#input_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of extra <br>build args to use for <br>the image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | false | | Name of image, without tags. <br>Not required if image_tags specified. |
| <a name="input_image_tags"></a>[image_tags](#input_image_tags) | string | false | | Default=the images are automatically tagged. <br>Override tags with space separated <br>list. |
| <a name="input_push"></a>[push](#input_push) | boolean | false | `true` | Override prevent pushing the image. |
| <a name="input_registry"></a>[registry](#input_registry) | string | false | `"ghcr.io"` | Override GHCR to use an <br>external reg. |
| <a name="input_scan_dockerfile"></a>[scan_dockerfile](#input_scan_dockerfile) | boolean | false | `true` | Enable dockerfile vulnerability scanning, prior <br>to build. |
| <a name="input_scan_image"></a>[scan_image](#input_scan_image) | boolean | false | `true` | Enable image vulnerability scan, after <br>build. |
| <a name="input_skip_cve"></a>[skip_cve](#input_skip_cve) | string | false | `"CKV_DOCKER_8,CKV_DOCKER_2,CKV_DOCKER_3,CKV_DOCKER_5"` | Skip specific CVE from checkcov <br>(override rules). |

<!-- AUTO-DOC-INPUT:END -->

Expand Down

0 comments on commit 2849199

Please sign in to comment.