Skip to content

docs: update actions and workflows documentation #630

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
Dec 19, 2025
Merged

docs: update actions and workflows documentation #630

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
22 changes: 11 additions & 11 deletions actions/docker/create-images-manifests/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/create-images-manifests@4f29319e02dd65152386c436e8c3136f380a0e71 # 0.28.0
- uses: hoverkraft-tech/ci-github-container/actions/docker/create-images-manifests@67e5563d6681bb610c1c961eecb6dfcd5b3cc62f # 0.30.5
with:
# OCI registry where to pull and push images
# This input is required.
Expand Down Expand Up @@ -100,16 +100,16 @@ permissions:

## Inputs

| **Input** | **Description** | **Required** | **Default** |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---------------------------------- |
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
| **`oci-registry-username`** | Username used to log against the OCI registry. See <https://github.com/docker/login-action#usage>. | **true** | `$\{\{ github.repository_owner }}` |
| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **true** | `$\{\{ github.token }}` |
| | Can be passed in using `secrets.GITHUB_TOKEN`. | | |
| | See <https://github.com/docker/login-action#usage>. | | |
| **`built-images`** | Built images data. | **true** | - |
| | Example: | | |
| | <!-- textlint-disable --><pre lang="json">{&#13; "application": {&#13; "name": "application",&#13; "registry": "ghcr.io",&#13; "repository": "my-org/my-repo/application",&#13; "tags": ["pr-63-5222075","pr-63"],&#13; "images": [&#13; "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",&#13; "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402",&#13; ],&#13; "annotations": {&#13; "org.opencontainers.image.created": "2021-09-30T14:00:00Z",&#13; "org.opencontainers.image.description": "Application image"&#13; },&#13; "platforms": ["linux/amd64", "linux/arm64"],&#13; "multi-platform": true&#13; }&#13;}</pre><!-- textlint-enable --> | | |
| **Input** | **Description** | **Required** | **Default** |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------- |
| **`oci-registry`** | OCI registry where to pull and push images | **true** | `ghcr.io` |
| **`oci-registry-username`** | Username used to log against the OCI registry. See <https://github.com/docker/login-action#usage>. | **true** | `${{ github.repository_owner }}` |
| **`oci-registry-password`** | Password or personal access token used to log against the OCI registry. | **true** | `${{ github.token }}` |
| | Can be passed in using `secrets.GITHUB_TOKEN`. | | |
| | See <https://github.com/docker/login-action#usage>. | | |
| **`built-images`** | Built images data. | **true** | - |
| | Example: | | |
| | <!-- textlint-disable --><pre lang="json">{&#13; "application": {&#13; "name": "application",&#13; "registry": "ghcr.io",&#13; "repository": "my-org/my-repo/application",&#13; "tags": ["pr-63-5222075","pr-63"],&#13; "images": [&#13; "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",&#13; "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402",&#13; ],&#13; "annotations": {&#13; "org.opencontainers.image.created": "2021-09-30T14:00:00Z",&#13; "org.opencontainers.image.description": "Application image"&#13; },&#13; "platforms": ["linux/amd64", "linux/arm64"],&#13; "multi-platform": true&#13; }&#13;}</pre><!-- textlint-enable --> | | |

<!-- inputs:end -->
<!-- outputs:start -->
Expand Down