From c1b56ee816514e126072cf473e689abcb76a955d Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Tue, 30 Jun 2026 17:55:45 +0000 Subject: [PATCH] docs(hoverkraft-tech/ci-github-container): update documentation Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../ci-github-container/CONTRIBUTING.md | 10 +- .../actions/docker/build-image/index.md | 34 +++---- .../actions/docker/clean-images/index.md | 18 ++-- .../actions/docker/cleanup-builder/index.md | 4 +- .../docker/create-images-manifests/index.md | 8 +- .../docker/get-image-metadata/index.md | 12 +-- .../actions/docker/get-image-name/index.md | 4 +- .../prune-pull-requests-image-tags/index.md | 20 ++-- .../actions/docker/setup/index.md | 6 +- .../actions/docker/sign-images/index.md | 4 +- .../actions/helm/generate-docs/index.md | 36 +++---- .../actions/helm/parse-chart-uri/index.md | 4 +- .../actions/helm/prepare-chart/index.md | 14 +-- .../actions/helm/release-chart/index.md | 22 ++--- .../actions/helm/test-chart/index.md | 44 ++++----- .../actions/helm/update-chart-values/index.md | 6 +- .../ci-github-container/github/_index.md | 6 +- .../github/workflows/docker-build-images.md | 54 +++++----- .../prune-pull-requests-images-tags.md | 32 +++--- .../ci-github-container/index.md | 24 ++--- application/docs/projects/index.mdx | 98 +++++++++---------- 21 files changed, 230 insertions(+), 230 deletions(-) diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md index 3012206cd..fe0a6938b 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-container source_path: CONTRIBUTING.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- # Contributing @@ -17,11 +17,11 @@ Please note we have a code of conduct, please follow it in all your interactions 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. -2. Update the README.md with details of changes to the interface, this includes new environment +1. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this +1. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you +1. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. ## Code of Conduct diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md index 9bcbaee29..7c9921b3c 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md @@ -3,8 +3,8 @@ title: Build Image source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/build-image/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -141,7 +141,7 @@ permissions: # See https://docs.docker.com/build/ci/github-actions/secrets/. secret-envs: "" - # Cache type. + # Cache type. Set to `false` or empty to disable cache entirely. # See https://docs.docker.com/build/cache/backends. # # Default: `gha` @@ -184,37 +184,37 @@ permissions: | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: | | | | | `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **true** | `${{ github.token }}` | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | | | | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`repository`** | Repository name. | **false** | `${{ github.repository }}` | | | Example: `my-org/my-repo`. | | | -| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | +| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | | **`image`** | Additional image name. | **false** | - | | | Example: `application`. | | | -| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | +| | See [Docker get-image-metadata action](../get-image-metadata/index.md). | | | | **`tag`** | Force image tag to publish | **false** | - | | **`platform`** | Platform to build for. Example: `linux/amd64`. | **true** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`context`** | Build's context is the set of files located in the specified PATH or URL. | **false** | `.` | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`dockerfile`** | Location of Dockerfile (defaults to Dockerfile). | **false** | `Dockerfile` | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`build-args`** | List of build-time variables. | **false** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`target`** | Sets the target stage to build. | **false** | - | -| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | +| | See [https://github.com/docker/build-push-action#inputs](https://github.com/docker/build-push-action#inputs). | | | | **`secrets`** | List of secrets to expose to the build. | **false** | - | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | | **`secret-envs`** | List of secret environment variables to expose to the build (e.g., `key=envname, MY_SECRET=MY_ENV_VAR`). | **false** | - | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | -| **`cache-type`** | Cache type. | **false** | `gha` | -| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | | +| **`cache-type`** | Cache type. Set to `false` or empty to disable cache entirely. | **false** | `gha` | +| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | Example for insecure registry: | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | **`multi-platform`** | Whether this build participates in a multi-platform image publication. | **false** | `false` | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md index 3063a2929..6aa76d74e 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md @@ -3,8 +3,8 @@ title: Clean Images source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/clean-images/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -82,13 +82,13 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | -| **`package`** | Comma-separated list of packages to cleanup. | **true** | - | -| | Example: "application-1,application-2" | | | -| **`tags`** | Comma-separated list of tags to delete (supports wildcard syntax). | **true** | - | -| | Example: `pr-*,dev` | | | -| **`github-token`** | GitHub token with the packages:write and packages:delete scopes. | **false** | `${{ github.token }}` | +| **Input** | **Description** | **Required** | **Default** | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- | +| **`package`** | Comma-separated list of packages to cleanup. | **true** | - | +| | Example: "application-1,application-2" | | | +| **`tags`** | Comma-separated list of tags to delete (supports wildcard syntax). | **true** | - | +| | Example: `pr-*,dev` | | | +| **`github-token`** | GitHub token with the packages:write and packages:delete scopes. | **false** | `${{ github.token }}` | | | See [https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries](https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/cleanup-builder/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/cleanup-builder/index.md index 383ccca11..58b4683e4 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/cleanup-builder/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/cleanup-builder/index.md @@ -3,8 +3,8 @@ title: Cleanup Builder source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/cleanup-builder/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md index 85e0cacf1..7f9bcead0 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md @@ -3,8 +3,8 @@ title: Create Images Manifests source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/create-images-manifests/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -137,12 +137,12 @@ permissions: | **`oci-registry-username`** | Username configuration used to log against OCI registries. | **true** | `${{ github.repository_owner }}` | | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **true** | `${{ github.token }}` | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | | | | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | **`built-images`** | Built images data. | **true** | - | | | Example: | | | | | 
{
 "application": {
 "name": "application",
 "registry": "ghcr.io",
 "repository": "my-org/my-repo/application",
 "tags": ["pr-63-5222075","pr-63"],
 "images": [
 "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",
 "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402",
 ],
 "annotations": {
 "org.opencontainers.image.created": "2021-09-30T14:00:00Z",
 "org.opencontainers.image.description": "Application image"
 },
 "platforms": ["linux/amd64", "linux/arm64"],
 "multi-platform": true
 }
}
| | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md index afdb7532a..14005e03e 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md @@ -3,8 +3,8 @@ title: Get Image Metadata source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/get-image-metadata/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -69,12 +69,12 @@ It uses the [docker/metadata-action](https://github.com/docker/metadata-action) ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------- | -| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` | +| **Input** | **Description** | **Required** | **Default** | +| ------------------ | -------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------- | +| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` | | **`repository`** | Repository name. Example: `my-org/my-repo`. See [Docker get-image-name action](../get-image-name/index.md) | **false** | `${{ github.repository }}` | | **`image`** | Additional image name. Example: `application`. See [Docker get-image-name action](../get-image-name/index.md) | **false** | - | -| **`tag`** | Force image tag to publish | **false** | - | +| **`tag`** | Force image tag to publish | **false** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-name/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-name/index.md index d19011208..8e41bb86c 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-name/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-name/index.md @@ -3,8 +3,8 @@ title: Get Image Name source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/get-image-name/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md index ae3406c56..1ee78f2f9 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md @@ -3,8 +3,8 @@ title: Prune Pull Requests Image Tags source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/prune-pull-requests-image-tags/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -81,14 +81,14 @@ permissions: ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- | -| **`image`** | Image name | **false** | - | -| **`pull-request-tag-filter`** | The regular expression to match pull request tags. Must have a capture group for the pull request number. | **false** | `^pr-([0-9]+)(?:-\|$)` | -| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | - | -| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | -| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | -| **`github-token`** | GitHub token with the following scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `${{ github.token }}` | +| **Input** | **Description** | **Required** | **Default** | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- | +| **`image`** | Image name | **false** | - | +| **`pull-request-tag-filter`** | The regular expression to match pull request tags. Must have a capture group for the pull request number. | **false** | `^pr-([0-9]+)(?:-\|$)` | +| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | - | +| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | +| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | +| **`github-token`** | GitHub token with the following scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `${{ github.token }}` | | | See [https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries](https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md index b61bb3057..0a33e44a9 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md @@ -3,8 +3,8 @@ title: Setup source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/setup/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -108,7 +108,7 @@ Shared action to configure Docker tooling and OCI registry authentication. | **`oci-registry-password`** | Password or personal access token configuration used to log against OCI registries. | **false** | - | | | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | Example for insecure registry: | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | **`built-images`** | Optional built images payload used to resolve manifest publication registries. | **false** | - | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/sign-images/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/sign-images/index.md index 744909262..e530b1307 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/sign-images/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/sign-images/index.md @@ -3,8 +3,8 @@ title: Sign Images source_repo: hoverkraft-tech/ci-github-container source_path: actions/docker/sign-images/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md index e3a4b125f..b38513bb5 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/generate-docs/index.md @@ -3,8 +3,8 @@ title: Generate Docs source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/generate-docs/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -85,22 +85,22 @@ Mainly using [losisin/helm-docs-github-action](https://github.com/losisin/helm-d ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------- | -| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | -| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | -| | Can be a branch, tag or commit SHA. | | | -| | Set to an empty string to skip checkout. | | | -| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | -| | See [https://github.com/losisin/helm-values-schema-json-action](https://github.com/losisin/helm-values-schema-json-action). | | | -| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` | -| | Permissions: | | | -| | - contents: write | | | -| | - pull-requests: write | | | -| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | -| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | +| **Input** | **Description** | **Required** | **Default** | +| -------------------------- | ------------------------------------------------------------------------- | ------------ | ------------------------- | +| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | +| **`checkout-ref`** | The Git ref to checkout before generating documentation. | **false** | `${{ github.ref }}` | +| | Can be a branch, tag or commit SHA. | | | +| | Set to an empty string to skip checkout. | | | +| **`values-file`** | Path to the values file to use for generating the documentation. | **false** | - | +| | See [https://github.com/losisin/helm-values-schema-json-action](https://github.com/losisin/helm-values-schema-json-action). | | | +| **`github-token`** | GitHub Token to create and merge pull request. | **false** | `${{ github.token }}` | +| | Permissions: | | | +| | - contents: write | | | +| | - pull-requests: write | | | +| **`github-app-client-id`** | GitHub App client ID to generate GitHub token in place of github-token. | **false** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | +| **`github-app-key`** | GitHub App private key to generate GitHub token in place of github-token. | **false** | - | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/parse-chart-uri/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/parse-chart-uri/index.md index 870dd5d59..1e4fd68ce 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/parse-chart-uri/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/parse-chart-uri/index.md @@ -3,8 +3,8 @@ title: Parse Chart Uri source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/parse-chart-uri/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md index 4822f2076..3f0936e82 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/prepare-chart/index.md @@ -3,8 +3,8 @@ title: Prepare Chart source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/prepare-chart/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -61,11 +61,11 @@ for all charts found under a path. ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| ----------------------- | ----------------------------------------------------------------------------------------- | ------------ | ----------- | -| **`path`** | Path containing the chart(s) to prepare | **true** | - | -| **`helm-repositories`** | List of Helm repositories to add before building chart dependencies. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| **Input** | **Description** | **Required** | **Default** | +| ----------------------- | -------------------------------------------------------------------- | ------------ | ----------- | +| **`path`** | Path containing the chart(s) to prepare | **true** | - | +| **`helm-repositories`** | List of Helm repositories to add before building chart dependencies. | **false** | - | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md index 8027a4055..534e3c9b8 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/release-chart/index.md @@ -3,8 +3,8 @@ title: Release Chart source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/release-chart/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -127,22 +127,22 @@ This action requires the following permissions on the repository: | **Input** | **Description** | **Required** | **Default** | | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | | **`oci-registry`** | OCI registry where to push chart. | **true** | `ghcr.io` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`oci-registry-username`** | OCI registry username. | **true** | `${{ github.repository_owner }}` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`oci-registry-password`** | OCI registry password. | **true** | `${{ github.token }}` | -| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | +| | See [https://github.com/appany/helm-oci-chart-releaser#usage](https://github.com/appany/helm-oci-chart-releaser#usage). | | | | **`chart`** | Chart name to release | **true** | - | | **`path`** | Path to the chart to release | **true** | - | | **`values`** | Define charts values to be filled. | **false** | - | -| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | +| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | | | Format: `[{ file, path, value }]`. | | | | | | | | | | Example: | | | | | | | | | | 
[
 {
 "file": "charts/application/charts/api/values.yaml",
 "path": ".image.registry", "value": "ghcr.io"
 }
]
| | | | **`helm-repositories`** | List of Helm repositories to add before release charts. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | | **`tag`** | The release tag to set to chart | **true** | - | | **`update-tag-paths`** | List of YAML paths to update with the tag. | **false** | `.version,.appVersion` | | | Comma separated list of paths. | | | @@ -158,10 +158,10 @@ This action requires the following permissions on the repository: ## Outputs -| **Output** | **Description** | -| ----------- | ----------------------------------------------------------------------------------------------------------- | -| **`image`** | Chart image (Format: `{registry}/{repository}/{image}:{tag}`). | -| | See [https://github.com/appany/helm-oci-chart-releaser](https://github.com/appany/helm-oci-chart-releaser). | +| **Output** | **Description** | +| ----------- | -------------------------------------------------------------- | +| **`image`** | Chart image (Format: `{registry}/{repository}/{image}:{tag}`). | +| | See [https://github.com/appany/helm-oci-chart-releaser](https://github.com/appany/helm-oci-chart-releaser). | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md index 5dcc7b00b..ec9b5d819 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/test-chart/index.md @@ -3,8 +3,8 @@ title: Test Chart source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/test-chart/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -104,26 +104,26 @@ Mainly using [helm/chart-testing-action](https://github.com/helm/chart-testing-a ## Inputs -| **Input** | **Description** | **Required** | **Default** | -| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | -| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | -| **`helm-set`** | Set values for Helm chart. | **false** | - | -| | Multiple values can be set using multiline string. | | | -| | Example: | | | -| | 
key1=value1
key2=value2
| | | -| **`helm-repositories`** | List of Helm repositories to add before testing charts. | **false** | - | -| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | -| **`oci-registry`** | OCI registry where to pull and push images | **false** | `ghcr.io` | -| **`oci-registry-username`** | Username used to log against the OCI registry. | **false** | `${{ github.repository_owner }}` | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | -| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **false** | `${{ github.token }}` | -| | Can be passed in using `secrets.GITHUB_TOKEN`. | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | -| **`check-diff-only`** | Only run lint and tests on changed charts. | **false** | `true` | -| **`enable-lint`** | Enable linting of the Helm chart. | **false** | `true` | -| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md](https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md). | | | -| **`enable-install`** | Enable installing the Helm chart. | **false** | `true` | -| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_install.md](https://github.com/helm/chart-testing/blob/main/doc/ct_install.md). | | | +| **Input** | **Description** | **Required** | **Default** | +| --------------------------- | --------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- | +| **`working-directory`** | Working directory | **false** | `${{ github.workspace }}` | +| **`helm-set`** | Set values for Helm chart. | **false** | - | +| | Multiple values can be set using multiline string. | | | +| | Example: | | | +| | 
key1=value1
key2=value2
| | | +| **`helm-repositories`** | List of Helm repositories to add before testing charts. | **false** | - | +| | See [https://helm.sh/docs/helm/helm_repo_add/](https://helm.sh/docs/helm/helm_repo_add/). | | | +| **`oci-registry`** | OCI registry where to pull and push images | **false** | `ghcr.io` | +| **`oci-registry-username`** | Username used to log against the OCI registry. | **false** | `${{ github.repository_owner }}` | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **false** | `${{ github.token }}` | +| | Can be passed in using `secrets.GITHUB_TOKEN`. | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | +| **`check-diff-only`** | Only run lint and tests on changed charts. | **false** | `true` | +| **`enable-lint`** | Enable linting of the Helm chart. | **false** | `true` | +| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md](https://github.com/helm/chart-testing/blob/main/doc/ct_lint.md). | | | +| **`enable-install`** | Enable installing the Helm chart. | **false** | `true` | +| | See [https://github.com/helm/chart-testing/blob/main/doc/ct_install.md](https://github.com/helm/chart-testing/blob/main/doc/ct_install.md). | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md index 83fd7c0a9..5e3a5c950 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/helm/update-chart-values/index.md @@ -3,8 +3,8 @@ title: Update Chart Values source_repo: hoverkraft-tech/ci-github-container source_path: actions/helm/update-chart-values/README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -76,7 +76,7 @@ Updates Helm chart values files before release. | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | | **`path`** | Path to the chart to update | **true** | - | | **`values`** | Define charts values to be filled. | **false** | - | -| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | +| | See [https://mikefarah.gitbook.io/yq/](https://mikefarah.gitbook.io/yq/). | | | | | Format: `[{ file, path, value }]`. | | | | | | | | | | Example: | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/_index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/_index.md index ff55bd10a..7289dea96 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/_index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/_index.md @@ -1,7 +1,7 @@ --- -title: Github -description: Overview for Github -sidebar_label: Github +title: GitHub +description: Overview for GitHub +sidebar_label: GitHub --- This page is generated automatically to introduce the GitHub documentation section. diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md index fa9627d60..b1fff9b63 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/docker-build-images.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-container source_path: .github/workflows/docker-build-images.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -165,7 +165,7 @@ jobs: # Default: `${{ github.repository_owner }}` build-secret-github-app-owner: ${{ github.repository_owner }} - # Cache type. + # Cache type. Set to `false` or empty to disable cache entirely. # See https://docs.docker.com/build/cache/backends. # # Default: `gha` @@ -201,7 +201,7 @@ jobs: | **Input** | **Description** | **Required** | **Type** | **Default** | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | -------------------------------- | | **`runs-on`** | Runner to use. JSON array of runners. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | | **`oci-registry`** | OCI registry configuration used to pull, push and cache images. | **false** | **string** | `ghcr.io` | | | Accepts either a registry hostname string (default format) or a JSON object. | | | | | | JSON example: `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}` | | | | @@ -214,29 +214,29 @@ jobs: | **`oci-registry-username`** | Username configuration used to log against OCI registries. | **false** | **string** | `${{ github.repository_owner }}` | | | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | | | | JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | | | | **`images`** | Images to build parameters. | **true** | **string** | - | | | JSON array of objects. | | | | | | Example: | | | | | | 
[
 {
 "name": "application",
 "context": ".",
 "dockerfile": "./docker/application/Dockerfile",
 "target": "prod",
 "build-args": {
 "APP_PATH": "./application/",
 "PROD_MODE": "true"
 },
 "secret-envs": {
 "GH_TOKEN": "GITHUB_TOKEN"
 },
 "platforms": [
 "linux/amd64",
 {
 "name": "darwin/amd64",
 "runs-on": "macos-latest"
 }
 ]
 }
]
| | | | | **`lfs`** | Enable Git LFS. | **false** | **boolean** | `true` | -| | See [https://github.com/actions/checkout?tab=readme-ov-file#usage](https://github.com/actions/checkout?tab=readme-ov-file#usage). | | | | +| | See [https://github.com/actions/checkout?tab=readme-ov-file#usage](https://github.com/actions/checkout?tab=readme-ov-file#usage). | | | | | **`build-secret-github-app-token-env`** | Environment variable name(s) to pass GitHub token generated by GitHub App. | **false** | **string** | `GITHUB_APP_TOKEN` | | | Can be a multiline string list. | | | | | | This is useful to pass a generated token to the build, as it is not possible to share generated secrets between jobs. | | | | | | Needs input `build-secret-github-app-client-id` and secret `build-secret-github-app-key`. | | | | | **`build-secret-github-app-client-id`** | GitHub App client ID to generate GitHub token to be passed as build secret env. | **false** | **string** | - | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | | **`build-secret-github-app-owner`** | The owner of the GitHub App installation. | **false** | **string** | `${{ github.repository_owner }}` | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | -| **`cache-type`** | Cache type. | **false** | **string** | `gha` | -| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | | | +| **`cache-type`** | Cache type. Set to `false` or empty to disable cache entirely. | **false** | **string** | `gha` | +| | See [https://docs.docker.com/build/cache/backends](https://docs.docker.com/build/cache/backends). | | | | | **`buildkitd-config-inline`** | Inline BuildKit daemon configuration. | **false** | **string** | - | -| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | +| | See [https://github.com/docker/setup-buildx-action#inputs](https://github.com/docker/setup-buildx-action#inputs). | | | | | | Example for insecure registry: | | | | | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | | **`sign`** | Sign built images. | **false** | **boolean** | `true` | -| | See [sign-images](../../actions/docker/sign-images/index.md). | | | | +| | See [sign-images](../../actions/docker/sign-images/index.md). | | | | @@ -244,16 +244,16 @@ jobs: ## Secrets -| **Secret** | **Description** | **Required** | -| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------ | -| **`oci-registry-password`** | Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries. | **true** | -| | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | -| | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | -| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | -| **`build-secrets`** | List of secrets to expose to the build. | **false** | -| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | -| **`build-secret-github-app-key`** | GitHub App private key to generate GitHub token to be passed as build secret env. | **false** | -| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | +| **Secret** | **Description** | **Required** | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------ | +| **`oci-registry-password`** | Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries. | **true** | +| | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | | +| | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | | +| | See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage). | | +| **`build-secrets`** | List of secrets to expose to the build. | **false** | +| | See [https://docs.docker.com/build/ci/github-actions/secrets/](https://docs.docker.com/build/ci/github-actions/secrets/). | | +| **`build-secret-github-app-key`** | GitHub App private key to generate GitHub token to be passed as build secret env. | **false** | +| | See [https://github.com/actions/create-github-app-token](https://github.com/actions/create-github-app-token). | | @@ -289,8 +289,8 @@ Optional pull registries without credentials are skipped, which is useful for pu ### Images entry parameters -| **Parameter** | **Description** | **Default** | **Required** | -| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------ | +| **Parameter** | **Description** | **Default** | **Required** | +| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------ | | **name** | Image name. Must be unique. It is used as `image` in [Docker build-image action](../../actions/docker/build-image/index.md) | | **true** | | **repository** | Repository name. See [Docker build-image action](../../actions/docker/build-image/index.md) | | **false** | | **context** | Build context. See [Docker build-image action](../../actions/docker/build-image/index.md) | . | **false** | @@ -302,9 +302,9 @@ Optional pull registries without credentials are skipped, which is useful for pu #### Platforms entry parameters -| **Parameter** | **Description** | **Default** | **Required** | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ | -| **name** | Platform name. Example: `linux/amd64` | | **true** | +| **Parameter** | **Description** | **Default** | **Required** | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------- | ----------- | ------------ | +| **name** | Platform name. Example: `linux/amd64` | | **true** | | **runs-on** | JSON array of runner(s) to use. See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job) | | **false** | ##### Default `runs-on` strategy diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md index f27c39fcf..0cc8f2383 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/github/workflows/prune-pull-requests-images-tags.md @@ -2,8 +2,8 @@ source_repo: hoverkraft-tech/ci-github-container source_path: .github/workflows/prune-pull-requests-images-tags.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -100,20 +100,20 @@ jobs: ### Workflow Call Inputs -| **Input** | **Description** | **Required** | **Type** | **Default** | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------- | -| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | -| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | -| **`images`** | Images to clean. | **true** | **string** | - | -| | Example: | | | | -| | 
 ["application-1","application-2"]
| | | | -| **`prune-cache-images`** | Prune cache image tags (like `application-1/cache`). | **false** | **boolean** | `false` | -| | Useful when building image with "registry" cache backend. | | | | -| **`pull-request-tag-filter`** | The regular expression to match pull request tags. | **false** | **string** | `^pr-([0-9]+)(?:-\|$)` | -| | Must have a capture group for the pull request number. | | | | -| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | **string** | - | -| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | | -| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | | +| **Input** | **Description** | **Required** | **Type** | **Default** | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ---------------------- | +| **`runs-on`** | JSON array of runner(s) to use. | **false** | **string** | `["ubuntu-latest"]` | +| | See [https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job](https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job). | | | | +| **`images`** | Images to clean. | **true** | **string** | - | +| | Example: | | | | +| | 
 ["application-1","application-2"]
| | | | +| **`prune-cache-images`** | Prune cache image tags (like `application-1/cache`). | **false** | **boolean** | `false` | +| | Useful when building image with "registry" cache backend. | | | | +| **`pull-request-tag-filter`** | The regular expression to match pull request tags. | **false** | **string** | `^pr-([0-9]+)(?:-\|$)` | +| | Must have a capture group for the pull request number. | | | | +| **`preserve-tags-filter`** | Optional regular expression to match tags that should be preserved (not deleted). | **false** | **string** | - | +| | Tags matching this pattern will never be deleted, even if they are on a package version with PR tags. | | | | +| | Example: `^v.*` to preserve version tags like v1.0.0, v2.1.3, etc. | | | | diff --git a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/index.md b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/index.md index 1ee39d663..2549716e3 100644 --- a/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/index.md +++ b/application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/index.md @@ -1,10 +1,10 @@ --- -title: Ci Github Container +title: Ci GitHub Container source_repo: hoverkraft-tech/ci-github-container source_path: README.md source_branch: main -source_run_id: 27414074625 -last_synced: 2026-06-12T12:03:44.895Z +source_run_id: 28464638836 +last_synced: 2026-06-30T17:55:19.125Z --- @@ -92,13 +92,13 @@ actions/{category}/{action-name}/ #### Action Definition Standards 1. **Consistent branding**: Use `author: hoverkraft` with `color: blue` and a meaningful `icon`. -2. **Pinned dependencies**: Reference third-party actions via exact SHAs to guarantee reproducibility. -3. **Input validation**: Validate critical inputs early within composite steps or supporting scripts. -4. **Idempotent steps**: Ensure actions can run multiple times without leaving residual state in the workspace. -5. **Multi-platform support**: Test actions in both `ubuntu-latest` and `windows-latest` runners when applicable. -6. **Cross-platform compatibility**: Uses `actions/github-script` steps for cross-platform compatibility. Avoid `run` steps. -7. **Logging**: Use structured logs with clear prefixes (`[build-image]`, `[helm-test-chart]`, …) to simplify debugging. -8. **Security**: Avoid shell interpolation with untrusted inputs; prefer parameterized commands or `set -euo pipefail` wrappers. +1. **Pinned dependencies**: Reference third-party actions via exact SHAs to guarantee reproducibility. +1. **Input validation**: Validate critical inputs early within composite steps or supporting scripts. +1. **Idempotent steps**: Ensure actions can run multiple times without leaving residual state in the workspace. +1. **Multi-platform support**: Test actions in both `ubuntu-latest` and `windows-latest` runners when applicable. +1. **Cross-platform compatibility**: Uses `actions/github-script` steps for cross-platform compatibility. Avoid `run` steps. +1. **Logging**: Use structured logs with clear prefixes (`[build-image]`, `[helm-test-chart]`, …) to simplify debugging. +1. **Security**: Avoid shell interpolation with untrusted inputs; prefer parameterized commands or `set -euo pipefail` wrappers. #### File Conventions @@ -146,8 +146,8 @@ make test-ct-install # Validate Helm charts via chart-testing The repository includes comprehensive end-to-end tests for all local GitHub Actions. These tests follow an **Arrange-Act-Assert** pattern: 1. **Arrange**: Set up test fixtures and inputs (e.g., checkout code, prepare test context) -2. **Act**: Execute the action being tested with specific inputs -3. **Assert**: Validate outputs match expected values using `actions/github-script` +1. **Act**: Execute the action being tested with specific inputs +1. **Assert**: Validate outputs match expected values using `actions/github-script` Test workflows are located in `.github/workflows/__test-action-*.yml` and `.github/workflows/__test-workflow-*.yml`. They run on: diff --git a/application/docs/projects/index.mdx b/application/docs/projects/index.mdx index a2e663113..9af9e873e 100644 --- a/application/docs/projects/index.mdx +++ b/application/docs/projects/index.mdx @@ -16,6 +16,54 @@ export const projectSections = [ projects: [ + { + + icon: '⚡', + + title: 'ci-github-container', + + titleHref: 'https://github.com/hoverkraft-tech/ci-github-container', + + meta: 'Go Template • ⭐ 5 • Updated Jun 30, 2026', + + description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context', + + tags: [ + + 'build', + + 'containers', + + 'continuous-integration', + + 'docker', + + 'github-actions' + + ], + + actions: [ + + { + + label: 'View on GitHub', + + href: 'https://github.com/hoverkraft-tech/ci-github-container' + + }, + + { + + label: 'Documentation', + + href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/' + + } + + ] + + }, + { icon: '⚡', @@ -248,54 +296,6 @@ export const projectSections = [ }, - { - - icon: '⚡', - - title: 'ci-github-container', - - titleHref: 'https://github.com/hoverkraft-tech/ci-github-container', - - meta: 'Go Template • ⭐ 5 • Updated Jun 12, 2026', - - description: 'Opinionated GitHub Actions and workflows for continuous integration in container (OCI) context', - - tags: [ - - 'build', - - 'containers', - - 'continuous-integration', - - 'docker', - - 'github-actions' - - ], - - actions: [ - - { - - label: 'View on GitHub', - - href: 'https://github.com/hoverkraft-tech/ci-github-container' - - }, - - { - - label: 'Documentation', - - href: 'https://docs.hoverkraft.cloud/docs/projects/github-actions-and-reusable-workflows/ci-github-container/' - - } - - ] - - }, - { icon: '⚡', @@ -1496,7 +1496,7 @@ export const projectSnapshot = { lastUpdated: '2026-06-30', - technologiesSummary: 'including JavaScript, Go Template, TypeScript, HCL, Shell, and more.' + technologiesSummary: 'including Go Template, JavaScript, TypeScript, HCL, Shell, and more.' };