Skip to content

Commit 923ecfe

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 67e5563 commit 923ecfe

File tree

8 files changed

+134
-134
lines changed

8 files changed

+134
-134
lines changed

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

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

‎.github/workflows/prune-pull-requests-images-tags.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ on:
4848
permissions: {}
4949
jobs:
5050
prune-pull-requests-images-tags:
51-
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@d706f273f42e4b4b0caf1b3a385cb8b9cb058fa0 # 0.30.2
51+
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@67e5563d6681bb610c1c961eecb6dfcd5b3cc62f # 0.30.5
5252
permissions: {}
5353
with:
5454
# JSON array of runner(s) to use.

‎actions/docker/build-image/README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ permissions:
4646
## Usage
4747
4848
```yaml
49-
- uses: hoverkraft-tech/ci-github-container/actions/docker/build-image@3256ec78f48fdaa4c9691c87dc7136fa561c456e # 0.30.3
49+
- uses: hoverkraft-tech/ci-github-container/actions/docker/build-image@67e5563d6681bb610c1c961eecb6dfcd5b3cc62f # 0.30.5
5050
with:
5151
# OCI registry where to pull and push images
5252
# This input is required.
@@ -135,40 +135,40 @@ permissions:
135135
136136
## Inputs
137137
138-
| **Input** | **Description** | **Required** | **Default** |
139-
| --------------------------- | -------------------------------------------------------------------------------------------------------- | ------------ | ---------------------------------- |
140-
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
141-
| **`oci-registry-username`** | Username used to log against the OCI registry. | **true** | `$\{\{ github.repository_owner }}` |
142-
| | See <https://github.com/docker/login-action#usage>. | | |
143-
| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **true** | `$\{\{ github.token }}` |
144-
| | Can be passed in using `secrets.GITHUB_TOKEN`. | | |
145-
| | See <https://github.com/docker/login-action#usage>. | | |
146-
| **`repository`** | Repository name. | **false** | `$\{\{ github.repository }}` |
147-
| | Example: `my-org/my-repo`. | | |
148-
| | See [Docker get-image-metadata action](../get-image-metadata/README.md). | | |
149-
| **`image`** | Additional image name. | **false** | - |
150-
| | Example: `application`. | | |
151-
| | See [Docker get-image-metadata action](../get-image-metadata/README.md). | | |
152-
| **`tag`** | Force image tag to publish | **false** | - |
153-
| **`platform`** | Platform to build for. Example: `linux/amd64`. | **true** | - |
154-
| | See <https://github.com/docker/build-push-action#inputs>. | | |
155-
| **`context`** | Build's context is the set of files located in the specified PATH or URL. | **false** | `.` |
156-
| | See <https://github.com/docker/build-push-action#inputs>. | | |
157-
| **`dockerfile`** | Location of Dockerfile (defaults to Dockerfile). | **false** | `Dockerfile` |
158-
| | See <https://github.com/docker/build-push-action#inputs>. | | |
159-
| **`build-args`** | List of build-time variables. | **false** | - |
160-
| | See <https://github.com/docker/build-push-action#inputs>. | | |
161-
| **`target`** | Sets the target stage to build. | **false** | - |
162-
| | See <https://github.com/docker/build-push-action#inputs>. | | |
163-
| **`secrets`** | List of secrets to expose to the build. | **false** | - |
164-
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | | |
165-
| **`secret-envs`** | List of secret environment variables to expose to the build (e.g., `key=envname, MY_SECRET=MY_ENV_VAR`). | **false** | - |
166-
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | | |
167-
| **`cache-type`** | Cache type. | **false** | `gha` |
168-
| | See <https://docs.docker.com/build/cache/backends>. | | |
169-
| **`multi-platform`** | Whether this build participates in a multi-platform image publication. | **false** | `false` |
170-
| | When true, the image is pushed by digest only so manifests can be assembled later. | | |
171-
| | When false, the image is pushed with its tags directly. | | |
138+
| **Input** | **Description** | **Required** | **Default** |
139+
| --------------------------- | -------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- |
140+
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
141+
| **`oci-registry-username`** | Username used to log against the OCI registry. | **true** | `${{ github.repository_owner }}` |
142+
| | See <https://github.com/docker/login-action#usage>. | | |
143+
| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **true** | `${{ github.token }}` |
144+
| | Can be passed in using `secrets.GITHUB_TOKEN`. | | |
145+
| | See <https://github.com/docker/login-action#usage>. | | |
146+
| **`repository`** | Repository name. | **false** | `${{ github.repository }}` |
147+
| | Example: `my-org/my-repo`. | | |
148+
| | See [Docker get-image-metadata action](../get-image-metadata/README.md). | | |
149+
| **`image`** | Additional image name. | **false** | - |
150+
| | Example: `application`. | | |
151+
| | See [Docker get-image-metadata action](../get-image-metadata/README.md). | | |
152+
| **`tag`** | Force image tag to publish | **false** | - |
153+
| **`platform`** | Platform to build for. Example: `linux/amd64`. | **true** | - |
154+
| | See <https://github.com/docker/build-push-action#inputs>. | | |
155+
| **`context`** | Build's context is the set of files located in the specified PATH or URL. | **false** | `.` |
156+
| | See <https://github.com/docker/build-push-action#inputs>. | | |
157+
| **`dockerfile`** | Location of Dockerfile (defaults to Dockerfile). | **false** | `Dockerfile` |
158+
| | See <https://github.com/docker/build-push-action#inputs>. | | |
159+
| **`build-args`** | List of build-time variables. | **false** | - |
160+
| | See <https://github.com/docker/build-push-action#inputs>. | | |
161+
| **`target`** | Sets the target stage to build. | **false** | - |
162+
| | See <https://github.com/docker/build-push-action#inputs>. | | |
163+
| **`secrets`** | List of secrets to expose to the build. | **false** | - |
164+
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | | |
165+
| **`secret-envs`** | List of secret environment variables to expose to the build (e.g., `key=envname, MY_SECRET=MY_ENV_VAR`). | **false** | - |
166+
| | See <https://docs.docker.com/build/ci/github-actions/secrets/>. | | |
167+
| **`cache-type`** | Cache type. | **false** | `gha` |
168+
| | See <https://docs.docker.com/build/cache/backends>. | | |
169+
| **`multi-platform`** | Whether this build participates in a multi-platform image publication. | **false** | `false` |
170+
| | When true, the image is pushed by digest only so manifests can be assembled later. | | |
171+
| | When false, the image is pushed with its tags directly. | | |
172172

173173
<!-- inputs:end -->
174174

‎actions/docker/get-image-metadata/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ It uses the [docker/metadata-action](https://github.com/docker/metadata-action)
3535
## Usage
3636

3737
```yaml
38-
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-metadata@d706f273f42e4b4b0caf1b3a385cb8b9cb058fa0 # 0.30.2
38+
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-metadata@67e5563d6681bb610c1c961eecb6dfcd5b3cc62f # 0.30.5
3939
with:
4040
# OCI registry where to pull and push images
4141
# This input is required.
@@ -59,12 +59,12 @@ It uses the [docker/metadata-action](https://github.com/docker/metadata-action)
5959
6060
## Inputs
6161
62-
| **Input** | **Description** | **Required** | **Default** |
63-
| ------------------ | -------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------------- |
64-
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
65-
| **`repository`** | Repository name. Example: `my-org/my-repo`. See [Docker get-image-name action](../get-image-name/README.md) | **false** | `$\{\{ github.repository }}` |
66-
| **`image`** | Additional image name. Example: `application`. See [Docker get-image-name action](../get-image-name/README.md) | **false** | - |
67-
| **`tag`** | Force image tag to publish | **false** | - |
62+
| **Input** | **Description** | **Required** | **Default** |
63+
| ------------------ | -------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------- |
64+
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
65+
| **`repository`** | Repository name. Example: `my-org/my-repo`. See [Docker get-image-name action](../get-image-name/README.md) | **false** | `${{ github.repository }}` |
66+
| **`image`** | Additional image name. Example: `application`. See [Docker get-image-name action](../get-image-name/README.md) | **false** | - |
67+
| **`tag`** | Force image tag to publish | **false** | - |
6868

6969
<!-- inputs:end -->
7070

‎actions/docker/prune-pull-requests-image-tags/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ permissions:
4444
## Usage
4545
4646
```yaml
47-
- uses: hoverkraft-tech/ci-github-container/actions/docker/prune-pull-requests-image-tags@d706f273f42e4b4b0caf1b3a385cb8b9cb058fa0 # 0.30.2
47+
- uses: hoverkraft-tech/ci-github-container/actions/docker/prune-pull-requests-image-tags@67e5563d6681bb610c1c961eecb6dfcd5b3cc62f # 0.30.5
4848
with:
4949
# Image name
5050
image: ""
@@ -66,12 +66,12 @@ permissions:
6666
6767
## Inputs
6868
69-
| **Input** | **Description** | **Required** | **Default** |
70-
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
71-
| **`image`** | Image name | **false** | - |
72-
| **`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]+)(?:-\|$)` |
73-
| **`github-token`** | GitHub token with the folowing scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `$\{\{ github.token }}` |
74-
| | See <https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries>. | | |
69+
| **Input** | **Description** | **Required** | **Default** |
70+
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------- |
71+
| **`image`** | Image name | **false** | - |
72+
| **`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]+)(?:-\|$)` |
73+
| **`github-token`** | GitHub token with the folowing scopes: `pull-requests:read`, `packages:read` and `packages:delete`. | **false** | `${{ github.token }}` |
74+
| | See <https://docs.github.com/en/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries>. | | |
7575

7676
<!-- inputs:end -->
7777

0 commit comments

Comments
 (0)