Skip to content

Commit 484f247

Browse files
hoverkraft-bot[bot]hoverkraft-bot[bot]
committed
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 86740f4 commit 484f247

4 files changed

Lines changed: 114 additions & 73 deletions

File tree

‎.github/workflows/docker-build-images.md‎

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ jobs:
5353
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@a0bab9151cc074af9f6c8204ab42a48d2d570379 # 0.30.6
5454
permissions: {}
5555
secrets:
56-
# Password or GitHub token (`packages:read` and `packages:write` scopes) used to log against the OCI registry.
56+
# Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries.
57+
# Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`.
58+
# JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}`
5759
# See https://github.com/docker/login-action#usage.
5860
#
5961
# This input is required.
@@ -74,17 +76,21 @@ jobs:
7476
runs-on: '["ubuntu-latest"]'
7577

7678
# OCI registry configuration used to pull, push and cache images.
77-
# Accepts either a registry hostname string or a JSON object with
78-
# `pull`, `pull:<name>`, `push` and `cache` keys.
79-
# Example:
80-
# `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}`
79+
# Accepts either a registry hostname string (default format) or a JSON object.
80+
# JSON example: `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}`
81+
# JSON object keys:
82+
# - `pull`: registry used to pull public or default base images
83+
# - `pull:<name>`: additional pull registry
84+
# - `push`: registry used for published images
85+
# - `cache`: registry used when `cache-type` is `registry`
86+
# If no `pull` key is provided, the `push` registry is also used for pulls.
87+
#
8188
# Default: `ghcr.io`
8289
oci-registry: ghcr.io
8390

8491
# Username configuration used to log against OCI registries.
85-
# Accepts either a single username string or a JSON object using the same keys as `oci-registry`.
86-
# Example:
87-
# `{"pull:private":"${{ github.repository_owner }}","push":"${{ github.repository_owner }}"}`
92+
# Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`.
93+
# JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}`
8894
# See https://github.com/docker/login-action#usage.
8995
#
9096
# Default: `${{ github.repository_owner }}`
@@ -173,9 +179,17 @@ jobs:
173179
| **`runs-on`** | Runner to use. JSON array of runners. | **false** | **string** | `["ubuntu-latest"]` |
174180
| | See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>. | | | |
175181
| **`oci-registry`** | OCI registry configuration used to pull, push and cache images. | **false** | **string** | `ghcr.io` |
176-
| | Accepts a single registry hostname or a JSON object with `pull`, `pull:<name>`, `push` and `cache` keys. | | | |
182+
| | Accepts either a registry hostname string (default format) or a JSON object. | | | |
183+
| | JSON example: `{"pull":"docker.io","pull:private":"ghcr.io","push":"ghcr.io"}` | | | |
184+
| | JSON object keys: | | | |
185+
| | - `pull`: registry used to pull public or default base images | | | |
186+
| | - `pull:<name>`: additional pull registry | | | |
187+
| | - `push`: registry used for published images | | | |
188+
| | - `cache`: registry used when `cache-type` is `registry` | | | |
189+
| | If no `pull` key is provided, the `push` registry is also used for pulls. | | | |
177190
| **`oci-registry-username`** | Username configuration used to log against OCI registries. | **false** | **string** | `${{ github.repository_owner }}` |
178-
| | Accepts a single username or a JSON object using the same keys as `oci-registry`. | | | |
191+
| | Accepts either a single username string (default format) or a JSON object using the same keys as `oci-registry`. | | | |
192+
| | JSON example: `{"pull:private":"$\{{ github.repository_owner }}","push":"$\{{ github.repository_owner }}"}` | | | |
179193
| | See <https://github.com/docker/login-action#usage>. | | | |
180194
| **`images`** | Images to build parameters. | **true** | **string** | - |
181195
| | JSON array of objects. | | | |
@@ -205,7 +219,8 @@ jobs:
205219
| **Secret** | **Description** | **Required** |
206220
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------ |
207221
| **`oci-registry-password`** | Password or GitHub token (`packages:read` and `packages:write` scopes) configuration used to log against OCI registries. | **true** |
208-
| | Accepts a single password/token or a JSON object using the same keys as `oci-registry`. | |
222+
| | Accepts either a single password/token string (default format) or a JSON object using the same keys as `oci-registry`. | |
223+
| | JSON example: `{"pull:private":"$\{{ github.token }}","push":"$\{{ github.token }}"}` | |
209224
| | See <https://github.com/docker/login-action#usage>. | |
210225
| **`build-secrets`** | List of secrets to expose to the build. | **false** |
211226
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | |

0 commit comments

Comments
 (0)