Skip to content

docs: update actions and workflows documentation #691

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
Mar 12, 2026
Merged

docs: update actions and workflows documentation #691

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
37 changes: 26 additions & 11 deletions .github/workflows/docker-build-images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ jobs:
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@a0bab9151cc074af9f6c8204ab42a48d2d570379 # 0.30.6
permissions: {}
secrets:
# Password or GitHub token (`packages:read` and `packages:write` scopes) used to log against the OCI registry.
# Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries.
# 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.
#
# This input is required.
Expand All @@ -74,17 +76,21 @@ jobs:
runs-on: '["ubuntu-latest"]'

# OCI registry configuration used to pull, push and cache images.
# Accepts either a registry hostname string or a JSON object with
# `pull`, `pull:<name>`, `push` and `cache` keys.
# Example:
# `{"pull":"docker.io","pull:private":"ghcr.io","push":"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"}`
# JSON object keys:
# - `pull`: registry used to pull public or default base images
# - `pull:<name>`: additional pull registry
# - `push`: registry used for published images
# - `cache`: registry used when `cache-type` is `registry`
# If no `pull` key is provided, the `push` registry is also used for pulls.
#
# Default: `ghcr.io`
oci-registry: ghcr.io

# Username configuration used to log against OCI registries.
# Accepts either a single username string or a JSON object using the same keys as `oci-registry`.
# Example:
# `{"pull:private":"${{ github.repository_owner }}","push":"${{ 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.
#
# Default: `${{ github.repository_owner }}`
Expand Down Expand Up @@ -173,9 +179,17 @@ jobs:
| **`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>. | | | |
| **`oci-registry`** | OCI registry configuration used to pull, push and cache images. | **false** | **string** | `ghcr.io` |
| | Accepts a single registry hostname or a JSON object with `pull`, `pull:<name>`, `push` and `cache` keys. | | | |
| | Accepts either a registry hostname string (default format) or a JSON object. | | | |
| | JSON example: `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}` | | | |
| | JSON object keys: | | | |
| | - `pull`: registry used to pull public or default base images | | | |
| | - `pull:<name>`: additional pull registry | | | |
| | - `push`: registry used for published images | | | |
| | - `cache`: registry used when `cache-type` is `registry` | | | |
| | If no `pull` key is provided, the `push` registry is also used for pulls. | | | |
| **`oci-registry-username`** | Username configuration used to log against OCI registries. | **false** | **string** | `${{ github.repository_owner }}` |
| | Accepts a single username or a JSON object using the same keys as `oci-registry`. | | | |
| | 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>. | | | |
| **`images`** | Images to build parameters. | **true** | **string** | - |
| | JSON array of objects. | | | |
Expand Down Expand Up @@ -205,7 +219,8 @@ jobs:
| **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 a single password/token or a JSON object using the same keys as `oci-registry`. | |
| | 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>. | |
| **`build-secrets`** | List of secrets to expose to the build. | **false** |
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | |
Expand Down
Loading