Skip to content

Commit

Permalink
docs: update actions and workflows documentation
Browse files Browse the repository at this point in the history 
[skip ci]

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@github-actions @hoverkraft-bot
github-actions[bot] authored and hoverkraft-bot[bot] committed Apr 8, 2024
1 parent 465a9a4 commit ffaa65f
Show file tree
Hide file tree
Showing 7 changed files with 156 additions and 93 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-build-images.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ permissions:

jobs:
docker-build-images:
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@0.15.3
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@0.16.0
secrets:
# Password or GitHub token (packages:read and packages:write scopes) used to log against the OCI registry.
# See https://github.com/docker/login-action#usage.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/prune-pull-requests-images-tags.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ permissions:

jobs:
main:
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@0.15.3
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@0.16.0
# Optional customizations.
with:
# Json array of runner(s) to use.
Expand Down
47 changes: 33 additions & 14 deletions actions/docker/create-images-manifests/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<!-- start branding -->

<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:package color:gray-dark>" />

<!-- end branding -->
<!-- start title -->

# GitHub Action: Create images manifests
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:package color:gray-dark>" /> GitHub Action: Create images manifests

<!-- end title -->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-container?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/ci-github-container?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/ci-github-container?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/ci-github-container?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/ci-github-container/total?logo=github&style=flat-square" alt="Downloads" />

<!-- end badges -->
<!-- start description -->

Expand All @@ -26,35 +32,48 @@ permissions:
<!-- start usage -->
```yaml
- uses: hoverkraft-tech/ci-github-container/actions/docker/[email protected]
- uses: hoverkraft-tech/ci-github-container@0.16.0
with:
# OCI registry where to pull and push images
# Description: OCI registry where to pull and push images
#
# Default: ghcr.io
oci-registry: ""

# Username used to log against the OCI registry. See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage)
# Description: Username used to log against the OCI registry. See
# [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage)
#
# Default: ${{ github.repository_owner }}
oci-registry-username: ""

# Password or personal access token used to log against the OCI registry. Can be
# passed in using "secrets.GITHUB_TOKEN". See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage)
# Description: Password or personal access token used to log against the OCI
# registry. Can be passed in using "secrets.GITHUB_TOKEN". See
# [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage)
#
# Default: ${{ github.token }}
oci-registry-password: ""

# Built images data. Example: { "application": { "name": "application", "image":
# "ghcr.io/my-org/my-repo/application", "digest": "sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "tags": ["ghcr.io/my-org/my-repo/application:pr-63-5222075","ghcr.io/my-org/my-repo/application:pr-63"] } }
# Description: Built images data. Example: { "application": { "name":
# "application", "registry": "ghcr.io", "repository":
# "my-org/my-repo/application", "tags": ["pr-63-5222075","pr-63"], "images": [
# "ghcr.io/my-org/my-repo/application:pr-63-5222075",
# "ghcr.io/my-org/my-repo/application:pr-63" ], "digests": [
# "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",
# "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402"
# ], "annotations": { "org.opencontainers.image.created": "2021-09-30T14:00:00Z",
# "org.opencontainers.image.description": "Application image" } } }
#
built-images: ""
```
<!-- end usage -->
<!-- start inputs -->
| **Input** | **Description** | **Default** | **Required** |
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ------------ |
| **<code>oci-registry</code>** | OCI registry where to pull and push images | <code>ghcr.io</code> | **true** |
| **<code>oci-registry-username</code>** | Username used to log against the OCI registry. See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage) | <code>${{ github.repository_owner }}</code> | **true** |
| **<code>oci-registry-password</code>** | Password or personal access token used to log against the OCI registry. Can be passed in using "secrets.GITHUB_TOKEN". See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage) | <code>${{ github.token }}</code> | **true** |
| **<code>built-images</code>** | Built images data. Example: { "application": { "name": "application", "image": "ghcr.io/my-org/my-repo/application", "digest": "sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef", "tags": ["ghcr.io/my-org/my-repo/application:pr-63-5222075","ghcr.io/my-org/my-repo/application:pr-63"] } } | | **true** |
| **Input** | **Description** | **Default** | **Required** |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ------------ |
| <code>oci-registry</code> | OCI registry where to pull and push images | <code>ghcr.io</code> | **true** |
| <code>oci-registry-username</code> | Username used to log against the OCI registry. See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage) | <code>${{ github.repository_owner }}</code> | **true** |
| <code>oci-registry-password</code> | Password or personal access token used to log against the OCI registry. Can be passed in using "secrets.GITHUB_TOKEN". See [https://github.com/docker/login-action#usage](https://github.com/docker/login-action#usage) | <code>${{ github.token }}</code> | **true** |
| <code>built-images</code> | Built images data. Example: { "application": { "name": "application", "registry": "ghcr.io", "repository": "my-org/my-repo/application", "tags": ["pr-63-5222075","pr-63"], "images": [ "ghcr.io/my-org/my-repo/application:pr-63-5222075", "ghcr.io/my-org/my-repo/application:pr-63" ], "digests": [ "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d", "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402" ], "annotations": { "org.opencontainers.image.created": "2021-09-30T14:00:00Z", "org.opencontainers.image.description": "Application image" } } } | | **true** |
<!-- end inputs -->
<!-- start outputs -->
Expand Down
52 changes: 31 additions & 21 deletions actions/docker/get-image-metadata/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<!-- start branding -->

<img src=".github/ghadocs/branding.svg" width="15%" align="center" alt="branding<icon:package color:gray-dark>" />

<!-- end branding -->
<!-- start title -->

# GitHub Action: Get image metadata
# <img src=".github/ghadocs/branding.svg" width="60px" align="center" alt="branding<icon:package color:gray-dark>" /> GitHub Action: Get image metadata

<!-- end title -->
<!-- start badges -->

<a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Freleases%2Flatest"><img src="https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-container?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20tag" /></a><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Freleases%2Flatest"><img src="https://img.shields.io/github/release-date/hoverkraft-tech/ci-github-container?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release%20by%20date" /></a><img src="https://img.shields.io/github/last-commit/hoverkraft-tech/ci-github-container?logo=github&style=flat-square" alt="Commit" /><a href="https%3A%2F%2Fgithub.com%2Fhoverkraft-tech%2Fci-github-container%2Fissues"><img src="https://img.shields.io/github/issues/hoverkraft-tech/ci-github-container?logo=github&style=flat-square" alt="Open%20Issues" /></a><img src="https://img.shields.io/github/downloads/hoverkraft-tech/ci-github-container/total?logo=github&style=flat-square" alt="Downloads" />

<!-- end badges -->
<!-- start description -->

Expand All @@ -17,44 +23,48 @@ Action to retrieve required metadata to build Docker image
<!-- start usage -->

```yaml
- uses: hoverkraft-tech/ci-github-container/actions/docker/[email protected]
- uses: hoverkraft-tech/ci-github-container@0.16.0
with:
# OCI registry where to pull and push images
# Description: OCI registry where to pull and push images
#
# Default: ghcr.io
oci-registry: ""

# Repository name. Example: 'my-org/my-repo'.
# See [Docker get-image-name action](../get-image-name/README.md)
# Description: Repository name. Example: 'my-org/my-repo'. See
# [Docker get-image-name action](../get-image-name/README.md)
#
# Default: ${{ github.repository }}
repository:
repository: ""

# Additional image name. Example: 'application'.
# See [Docker get-image-name action](../get-image-name/README.md)
# Default: ${{ github.repository }}
# Description: Additional image name. Example: 'application'. See
# [Docker get-image-name action](../get-image-name/README.md)
#
image: ""

# Force image tag to publish
# Description: Force image tag to publish
#
tag: ""
```
<!-- end usage -->
<!-- start inputs -->
| **Input** | **Description** | **Default** | **Required** |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------ |
| **<code>oci-registry</code>** | OCI registry where to pull and push images | <code>ghcr.io</code> | **true** |
| **<code>repository</code>** | Repository name. Example: 'my-org/my-repo'. See [Docker get-image-name action](../get-image-name/README.md) | <code>${{ github.repository }}</code> | **false** |
| **<code>image</code>** | Additional image name. Example: 'application'. See [Docker get-image-name action](../get-image-name/README.md) | | **false** |
| **<code>tag</code>** | Force image tag to publish | | **false** |
| **Input** | **Description** | **Default** | **Required** |
| ------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------ |
| <code>oci-registry</code> | OCI registry where to pull and push images | <code>ghcr.io</code> | **true** |
| <code>repository</code> | Repository name. Example: 'my-org/my-repo'. See [Docker get-image-name action](../get-image-name/README.md) | <code>${{ github.repository }}</code> | **false** |
| <code>image</code> | Additional image name. Example: 'application'. See [Docker get-image-name action](../get-image-name/README.md) | | **false** |
| <code>tag</code> | Force image tag to publish | | **false** |
<!-- end inputs -->
<!-- start outputs -->
| **Output** | **Description** |
| ------------------- | ------------------------------------------------------------------------------------ |
| <code>image</code> | Forged image name containing registry. Example: "ghcr.io/my-org/my-repo/application" |
| <code>labels</code> | The image labels. |
| <code>tags</code> | The image tags. Example: "pr-63-5222075\npr-63" |
| **Output** | **Description** |
| ------------------------ | ------------------------------------------------------------------------------------ |
| <code>image</code> | Forged image name containing registry. Example: "ghcr.io/my-org/my-repo/application" |
| <code>labels</code> | The image labels. |
| <code>annotations</code> | The image annotations. |
| <code>tags</code> | The image tags. Example: "pr-63-5222075\npr-63" |
<!-- end outputs -->
<!-- start [.github/ghadocs/examples/] -->
Expand Down
Loading

0 comments on commit ffaa65f

Please sign in to comment.