Skip to content

Commit f255b92

Browse files
docs: update actions and workflows documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 6931f48 commit f255b92

17 files changed

Lines changed: 52 additions & 24 deletions

File tree

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1717
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1818
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
19+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
1920

2021
<!-- badges:end -->
2122

@@ -50,7 +51,7 @@ on:
5051
permissions: {}
5152
jobs:
5253
docker-build-images:
53-
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@676925b78f1970281b3f087bc3829eb1c6a9f4dc # 0.34.1
54+
uses: hoverkraft-tech/ci-github-container/.github/workflows/docker-build-images.yml@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
5455
permissions:
5556
contents: read
5657
id-token: write

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1717
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1818
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
19+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
1920

2021
<!-- badges:end -->
2122

@@ -47,7 +48,7 @@ on:
4748
permissions: {}
4849
jobs:
4950
prune-pull-requests-images-tags:
50-
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@676925b78f1970281b3f087bc3829eb1c6a9f4dc # 0.34.1
51+
uses: hoverkraft-tech/ci-github-container/.github/workflows/prune-pull-requests-images-tags.yml@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
5152
permissions:
5253
contents: read
5354
packages: write

actions/docker/build-image/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ permissions:
4747
## Usage
4848
4949
````yaml
50-
- uses: hoverkraft-tech/ci-github-container/actions/docker/build-image@8e63086f032651bcd1d44c8f4fcd61b902ebb99f # 0.35.0
50+
- uses: hoverkraft-tech/ci-github-container/actions/docker/build-image@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
5151
with:
5252
# OCI registry configuration used to pull, push and cache images.
5353
# Accepts either a registry hostname string (default format) or a JSON object.

actions/docker/clean-images/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1818
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1919
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
20+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
2021

2122
<!-- badges:end -->
2223

@@ -45,7 +46,7 @@ permissions:
4546
## Usage
4647
4748
```yaml
48-
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@260358ba1fd405c57bc669823d89c625971a3431 # 0.34.2
49+
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
4950
with:
5051
# Comma-separated list of packages to cleanup.
5152
# Example: "application-1,application-2"
@@ -109,7 +110,7 @@ jobs:
109110
permissions:
110111
packages: write
111112
steps:
112-
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@260358ba1fd405c57bc669823d89c625971a3431 # 0.34.2
113+
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
113114
with:
114115
package: my-app
115116
delete-tags: pr-${{ github.event.pull_request.number }}-*
@@ -131,7 +132,7 @@ jobs:
131132
permissions:
132133
packages: write
133134
steps:
134-
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@260358ba1fd405c57bc669823d89c625971a3431 # 0.34.2
135+
- uses: hoverkraft-tech/ci-github-container/actions/docker/clean-images@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
135136
with:
136137
package: my-app
137138
delete-untagged: true

actions/docker/cleanup-builder/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Register a post-job step that removes a Docker Buildx builder after later post s
2121
## Usage
2222

2323
```yaml
24-
- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@2b647ed6f11d50cb6beb6d56333e68ba2c804826 # 0.33.1
24+
- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
2525
with:
2626
# Docker Buildx builder name to remove during post-job cleanup.
2727
builder: ""
@@ -78,6 +78,7 @@ For more details, see the [license](http://choosealicense.com/licenses/mit/).
7878
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
7979
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
8080
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
81+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
8182

8283
<!-- badges:end -->
8384
<!-- secrets:start -->

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1717
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1818
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
19+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
1920

2021
<!-- badges:end -->
2122

@@ -45,7 +46,7 @@ permissions:
4546
## Usage
4647
4748
````yaml
48-
- uses: hoverkraft-tech/ci-github-container/actions/docker/create-images-manifests@676925b78f1970281b3f087bc3829eb1c6a9f4dc # 0.34.1
49+
- uses: hoverkraft-tech/ci-github-container/actions/docker/create-images-manifests@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
4950
with:
5051
# OCI registry configuration used to pull, push and cache images.
5152
# Accepts either a registry hostname string (default format) or a JSON object.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1818
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1919
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
20+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
2021

2122
<!-- badges:end -->
2223

@@ -35,7 +36,7 @@ It uses the [docker/metadata-action](https://github.com/docker/metadata-action)
3536
## Usage
3637

3738
```yaml
38-
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-metadata@260358ba1fd405c57bc669823d89c625971a3431 # 0.34.2
39+
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-metadata@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
3940
with:
4041
# OCI registry where to pull and push images
4142
# This input is required.

actions/docker/get-image-name/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1818
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1919
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
20+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
2021

2122
<!-- badges:end -->
2223

@@ -33,7 +34,7 @@ Action to forge the name of a given image including registry, repository and giv
3334
## Usage
3435

3536
```yaml
36-
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-name@2b647ed6f11d50cb6beb6d56333e68ba2c804826 # 0.33.1
37+
- uses: hoverkraft-tech/ci-github-container/actions/docker/get-image-name@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
3738
with:
3839
# OCI registry to prefix the image full name
3940
oci-registry: ""

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
1818
[![Stars](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)](https://img.shields.io/github/stars/hoverkraft-tech/ci-github-container?style=social)
1919
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
20+
[![codecov](https://codecov.io/gh/hoverkraft-tech/compose-action/graph/badge.svg?token=90JXB7EIMA)](https://codecov.io/gh/hoverkraft-tech/compose-action)
2021

2122
<!-- badges:end -->
2223

@@ -44,7 +45,7 @@ permissions:
4445
## Usage
4546
4647
```yaml
47-
- uses: hoverkraft-tech/ci-github-container/actions/docker/prune-pull-requests-image-tags@676925b78f1970281b3f087bc3829eb1c6a9f4dc # 0.34.1
48+
- uses: hoverkraft-tech/ci-github-container/actions/docker/prune-pull-requests-image-tags@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
4849
with:
4950
# Image name
5051
image: ""

actions/docker/setup/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Shared action to configure Docker tooling and OCI registry authentication.
3131
## Usage
3232

3333
````yaml
34-
- uses: hoverkraft-tech/ci-github-container/actions/docker/setup@8e63086f032651bcd1d44c8f4fcd61b902ebb99f # 0.35.0
34+
- uses: hoverkraft-tech/ci-github-container/actions/docker/setup@6931f4886bf8af8570acbace09db06a639cbae6f # 0.36.0
3535
with:
3636
# OCI registry configuration used to pull, push and cache images.
3737
# Accepts either a registry hostname string (default format) or a JSON object.

0 commit comments

Comments
 (0)