Skip to content

Commit 625e782

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 b4d639d commit 625e782

3 files changed

Lines changed: 38 additions & 11 deletions

File tree

actions/docker/cleanup-builder/README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- header:start -->
22

3-
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItdHJhc2gtMiIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjMgNiA1IDIwIDIxIDIwIDIxIDYiPjwvcG9seWxpbmU+PHBhdGggZD0iTTE5IDZWNGExIDEgMCAwIDAtMS0xaC00YTEgMSAwIDAgMC0xIDF2Mk01IDZoMTQiPjwvcGF0aD48cGF0aCBkPSJNMTAgMTF2NiI+PC9wYXRoPjxwYXRoIGQ9Ik0xNCAxMXY2Ij48L3BhdGg+PC9zdmc+) GitHub Action: Docker - Cleanup builder
3+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItdHJhc2gtMiIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjMgNiA1IDYgMjEgNiI+PC9wb2x5bGluZT48cGF0aCBkPSJNMTkgNnYxNGEyIDIgMCAwIDEtMiAySDdhMiAyIDAgMCAxLTItMlY2bTMgMFY0YTIgMiAwIDAgMSAyLTJoNGEyIDIgMCAwIDEgMiAydjIiPjwvcGF0aD48bGluZSB4MT0iMTAiIHkxPSIxMSIgeDI9IjEwIiB5Mj0iMTciPjwvbGluZT48bGluZSB4MT0iMTQiIHkxPSIxMSIgeDI9IjE0IiB5Mj0iMTciPjwvbGluZT48L3N2Zz4=) GitHub Action: Docker - Cleanup builder
44

55
<div align="center">
66
<img src="../../../.github/logo.svg" width="60px" align="center" alt="Docker - Cleanup builder" />
@@ -13,18 +13,21 @@
1313

1414
## Overview
1515

16-
Registers a post-job step that removes a Docker Buildx builder after later post-job hooks have finished.
17-
This action exists as a workaround for GitHub Actions post-step ordering behavior with composite actions, where the effective cleanup order may not match the visible reverse order of YAML steps.
16+
Register a post-job step that removes a Docker Buildx builder after later post steps have finished.
1817

1918
<!-- overview:end -->
2019
<!-- usage:start -->
2120

2221
## Usage
2322

2423
```yaml
25-
- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@main
24+
- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@bcbbcaff24e053e38ebab02dd0e41442df196719 # 0.32.0
2625
with:
27-
builder: ${{ steps.docker-setup.outputs.buildx-name }}
26+
# Docker Buildx builder name to remove during post-job cleanup.
27+
builder: ""
28+
29+
# Whether cleanup should run during the post-job phase.
30+
# Default: `true`
2831
enabled: true
2932
```
3033
@@ -68,3 +71,27 @@ Copyright © 2026 hoverkraft
6871
For more details, see the [license](http://choosealicense.com/licenses/mit/).
6972

7073
<!-- license:end -->
74+
<!-- badges:start -->
75+
76+
[![Marketplace](https://img.shields.io/badge/Marketplace-docker------cleanup--builder-blue?logo=github-actions)](https://github.com/marketplace/actions/docker---cleanup-builder)
77+
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-container)](https://github.com/hoverkraft-tech/ci-github-container/releases)
78+
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
79+
[![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)
80+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
81+
82+
<!-- badges:end -->
83+
<!-- secrets:start -->
84+
<!-- secrets:end -->
85+
<!-- outputs:start -->
86+
<!-- outputs:end -->
87+
<!-- examples:start -->
88+
<!-- examples:end -->
89+
<!-- security:start -->
90+
<!-- security:end -->
91+
<!-- generated:start -->
92+
93+
---
94+
95+
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
96+
97+
<!-- generated:end -->

actions/docker/setup/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ Shared action to configure Docker tooling and OCI registry authentication.
6262
# When provided, registry authentication targets are inferred from the built image data.
6363
built-images: ""
6464

65-
# Whether the Buildx builder should be removed during post-job cleanup.
65+
# Whether to install and configure Docker Buildx.
6666
#
6767
# Default: `true`
68-
buildx-cleanup: true
68+
setup-buildx: true
6969

70-
# Whether to install and configure Docker Buildx.
70+
# Whether the Buildx builder should be removed during post-job cleanup.
7171
#
7272
# Default: `true`
73-
setup-buildx: true
73+
buildx-cleanup: true
7474
````
7575

7676
<!-- usage:end -->
@@ -93,8 +93,8 @@ Shared action to configure Docker tooling and OCI registry authentication.
9393
| | <!-- textlint-disable --><pre lang="ini">[registry."my-registry.local:5000"]&#13; http = true&#13; insecure = true</pre><!-- textlint-enable --> | | |
9494
| **`built-images`** | Optional built images payload used to resolve manifest publication registries. | **false** | - |
9595
| | When provided, registry authentication targets are inferred from the built image data. | | |
96-
| **`buildx-cleanup`** | Whether the Buildx builder should be removed during post-job cleanup. | **false** | `true` |
9796
| **`setup-buildx`** | Whether to install and configure Docker Buildx. | **false** | `true` |
97+
| **`buildx-cleanup`** | Whether the Buildx builder should be removed during post-job cleanup. | **false** | `true` |
9898

9999
<!-- inputs:end -->
100100

actions/helm/test-chart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Mainly using [helm/chart-testing-action](https://github.com/helm/chart-testing-a
3434
## Usage
3535

3636
````yaml
37-
- uses: hoverkraft-tech/ci-github-container/actions/helm/test-chart@a0bab9151cc074af9f6c8204ab42a48d2d570379 # 0.30.6
37+
- uses: hoverkraft-tech/ci-github-container/actions/helm/test-chart@bcbbcaff24e053e38ebab02dd0e41442df196719 # 0.32.0
3838
with:
3939
# Working directory
4040
# Default: `${{ github.workspace }}`

0 commit comments

Comments
 (0)