Skip to content

docs: update actions and workflows documentation #693

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 13, 2026
Merged

docs: update actions and workflows documentation #693

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
30 changes: 15 additions & 15 deletions actions/docker/sign-images/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ permissions:
## Usage

````yaml
- uses: hoverkraft-tech/ci-github-container/actions/docker/sign-images@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
- uses: hoverkraft-tech/ci-github-container/actions/docker/sign-images@a0bab9151cc074af9f6c8204ab42a48d2d570379 # 0.30.6
with:
# Images to sign.
# Can be a single image or a list of images separated by commas or newlines or spaces.
Expand Down Expand Up @@ -79,19 +79,19 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------- |
| **`images`** | Images to sign. | **true** | - |
| | Can be a single image or a list of images separated by commas or newlines or spaces. | | |
| | The images should be in the format `registry/name:tag@digest`. | | |
| | It can also be a list of images in JSON format. | | |
| | Example: | | |
| | | | |
| | <!-- 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 --> | | |
| | If the image does not have a digest, it will retrieve the digest using `docker buildx imagetools inspect`. | | |
| **`github-token`** | GitHub Token to sign the image. | **false** | `$\{\{ github.token }}` |
| | Permissions: | | |
| | - `id-token`: `write` | | |
| **Input** | **Description** | **Required** | **Default** |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------- |
| **`images`** | Images to sign. | **true** | - |
| | Can be a single image or a list of images separated by commas or newlines or spaces. | | |
| | The images should be in the format `registry/name:tag@digest`. | | |
| | It can also be a list of images in JSON format. | | |
| | Example: | | |
| | | | |
| | <!-- 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 --> | | |
| | If the image does not have a digest, it will retrieve the digest using `docker buildx imagetools inspect`. | | |
| **`github-token`** | GitHub Token to sign the image. | **false** | `${{ github.token }}` |
| | Permissions: | | |
| | - `id-token`: `write` | | |

<!-- inputs:end -->

Expand Down Expand Up @@ -127,7 +127,7 @@ This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 hoverkraft
Copyright © 2026 hoverkraft

For more details, see the [license](http://choosealicense.com/licenses/mit/).

Expand Down