Skip to content

docs(hoverkraft-tech/ci-github-container): update documentation #1250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoverkraft-bot merged 1 commit into from
Jun 30, 2026
Merged

docs(hoverkraft-tech/ci-github-container): update documentation #1250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...jects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
34 changes: 17 additions & 17 deletions ...-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<!-- header:start -->
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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: | | |
| | <!-- textlint-disable --><pre lang="ini">[registry."my-registry.local:5000"]&#13; http = true&#13; insecure = true</pre><!-- textlint-enable --> | | |
| **`multi-platform`** | Whether this build participates in a multi-platform image publication. | **false** | `false` |
Expand Down
18 changes: 9 additions & 9 deletions ...and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<!-- header:start -->
Expand Down Expand Up @@ -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). | | |

<!-- inputs:end -->
Expand Down
4 changes: 2 additions & 2 deletions ...-reusable-workflows/ci-github-container/actions/docker/cleanup-builder/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<!-- header:start -->
Expand Down
Loading
Loading