Skip to content

Commit 30cfe87

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 2408dd0 commit 30cfe87

File tree

9 files changed

+150
-142
lines changed

9 files changed

+150
-142
lines changed

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

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

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ See [prune-pull-requests-image-tags](../../actions/docker/prune-pull-requests-im
2929
### Permissions
3030

3131
- **`contents`**: `read`
32-
- **`pull-requests`**: `read`
33-
- **`packages`**: `write`
3432
- **`id-token`**: `write`
33+
- **`packages`**: `write`
34+
- **`pull-requests`**: `read`
3535

3636
<!-- overview:end -->
3737

@@ -52,7 +52,7 @@ permissions:
5252
id-token: write
5353
jobs:
5454
prune-pull-requests-images-tags:
55-
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@f9e149b6cdfa8443994994f10085691a57b8cf0e # 0.27.1
55+
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
5656
with:
5757
# JSON array of runner(s) to use.
5858
# See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.

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

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

‎actions/docker/create-images-manifests/README.md‎

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

‎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@f9e149b6cdfa8443994994f10085691a57b8cf0e # 0.27.1
38+
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-metadata@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
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/get-image-name/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Action to forge the name of a given image including registry, repository and giv
3333
## Usage
3434

3535
```yaml
36-
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-name@f9e149b6cdfa8443994994f10085691a57b8cf0e # 0.27.1
36+
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-name@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
3737
with:
3838
# OCI registry to prefix the image full name
3939
oci-registry: ""
@@ -52,11 +52,11 @@ Action to forge the name of a given image including registry, repository and giv
5252
5353
## Inputs
5454
55-
| **Input** | **Description** | **Required** | **Default** |
56-
| ------------------ | ------------------------------------------ | ------------ | -------------------------- |
57-
| **`oci-registry`** | OCI registry to prefix the image full name | **false** | - |
58-
| **`repository`** | Repository name | **false** | `${{ github.repository }}` |
59-
| **`image`** | Additional image name | **false** | - |
55+
| **Input** | **Description** | **Required** | **Default** |
56+
| ------------------ | ------------------------------------------ | ------------ | ---------------------------- |
57+
| **`oci-registry`** | OCI registry to prefix the image full name | **false** | - |
58+
| **`repository`** | Repository name | **false** | `$\{\{ github.repository }}` |
59+
| **`image`** | Additional image name | **false** | - |
6060

6161
<!-- inputs:end -->
6262

‎actions/docker/sign-images/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ permissions:
4545
## Usage
4646
4747
````yaml
48-
- uses: hoverkraft-tech/ci-github-container/actions/docker/sign-images@f9e149b6cdfa8443994994f10085691a57b8cf0e # 0.27.1
48+
- uses: hoverkraft-tech/ci-github-container/actions/docker/sign-images@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
4949
with:
5050
# Images to sign.
5151
# Can be a single image or a list of images separated by commas or newlines or spaces.
@@ -79,19 +79,19 @@ permissions:
7979

8080
## Inputs
8181

82-
| **Input** | **Description** | **Required** | **Default** |
83-
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
84-
| **`images`** | Images to sign. | **true** | - |
85-
| | Can be a single image or a list of images separated by commas or newlines or spaces. | | |
86-
| | The images should be in the format `registry/name:tag@digest`. | | |
87-
| | It can also be a list of images in JSON format. | | |
88-
| | Example: | | |
89-
| | | | |
90-
| | <!-- textlint-disable --><pre lang="json">[&#13; "ghcr.io/my-org/my-repo/application:pr-63-5222075@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",&#13; "ghcr.io/my-org/my-repo/application:pr-63@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402"&#13;]</pre><!-- textlint-enable --> | | |
91-
| | If the image does not have a digest, it will retrieve the digest using `docker buildx imagetools inspect`. | | |
92-
| **`github-token`** | GitHub Token to sign the image. | **false** | `${{ github.token }}` |
93-
| | Permissions: | | |
94-
| | - `id-token`: `write` | | |
82+
| **Input** | **Description** | **Required** | **Default** |
83+
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
84+
| **`images`** | Images to sign. | **true** | - |
85+
| | Can be a single image or a list of images separated by commas or newlines or spaces. | | |
86+
| | The images should be in the format `registry/name:tag@digest`. | | |
87+
| | It can also be a list of images in JSON format. | | |
88+
| | Example: | | |
89+
| | | | |
90+
| | <!-- textlint-disable --><pre lang="json">[&#13; "ghcr.io/my-org/my-repo/application:pr-63-5222075@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",&#13; "ghcr.io/my-org/my-repo/application:pr-63@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402"&#13;]</pre><!-- textlint-enable --> | | |
91+
| | If the image does not have a digest, it will retrieve the digest using `docker buildx imagetools inspect`. | | |
92+
| **`github-token`** | GitHub Token to sign the image. | **false** | `$\{\{ github.token }}` |
93+
| | Permissions: | | |
94+
| | - `id-token`: `write` | | |
9595

9696
<!-- inputs:end -->
9797

‎actions/helm/parse-chart-uri/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The output will be:
4040
## Usage
4141

4242
```yaml
43-
- uses: hoverkraft-tech/ci-github-container/actions/helm/parse-chart-uri@f9e149b6cdfa8443994994f10085691a57b8cf0e # 0.27.1
43+
- uses: hoverkraft-tech/ci-github-container/actions/helm/parse-chart-uri@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
4444
with:
4545
# Chart URI to parse.
4646
# This input is required.

0 commit comments

Comments
 (0)