From 92ff28fbef13ef2a0352f52ee3e4578b328d0eca Mon Sep 17 00:00:00 2001 From: "hoverkraft-bot[bot]" <128996893+hoverkraft-bot[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 16:51:12 +0000 Subject: [PATCH] docs: update actions and workflows documentation [skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- actions/docker/cleanup-builder/README.md | 37 ++++++++++++++++++++---- actions/docker/setup/README.md | 10 +++---- actions/helm/test-chart/README.md | 2 +- 3 files changed, 38 insertions(+), 11 deletions(-) diff --git a/actions/docker/cleanup-builder/README.md b/actions/docker/cleanup-builder/README.md index 02d70ce4..bc4566de 100644 --- a/actions/docker/cleanup-builder/README.md +++ b/actions/docker/cleanup-builder/README.md @@ -1,6 +1,6 @@ -# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItdHJhc2gtMiIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjMgNiA1IDIwIDIxIDIwIDIxIDYiPjwvcG9seWxpbmU+PHBhdGggZD0iTTE5IDZWNGExIDEgMCAwIDAtMS0xaC00YTEgMSAwIDAgMC0xIDF2Mk01IDZoMTQiPjwvcGF0aD48cGF0aCBkPSJNMTAgMTF2NiI+PC9wYXRoPjxwYXRoIGQ9Ik0xNCAxMXY2Ij48L3BhdGg+PC9zdmc+) GitHub Action: Docker - Cleanup builder +# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItdHJhc2gtMiIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjMgNiA1IDYgMjEgNiI+PC9wb2x5bGluZT48cGF0aCBkPSJNMTkgNnYxNGEyIDIgMCAwIDEtMiAySDdhMiAyIDAgMCAxLTItMlY2bTMgMFY0YTIgMiAwIDAgMSAyLTJoNGEyIDIgMCAwIDEgMiAydjIiPjwvcGF0aD48bGluZSB4MT0iMTAiIHkxPSIxMSIgeDI9IjEwIiB5Mj0iMTciPjwvbGluZT48bGluZSB4MT0iMTQiIHkxPSIxMSIgeDI9IjE0IiB5Mj0iMTciPjwvbGluZT48L3N2Zz4=) GitHub Action: Docker - Cleanup builder
Docker - Cleanup builder @@ -13,8 +13,7 @@ ## Overview -Registers a post-job step that removes a Docker Buildx builder after later post-job hooks have finished. -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. +Register a post-job step that removes a Docker Buildx builder after later post steps have finished. @@ -22,9 +21,13 @@ This action exists as a workaround for GitHub Actions post-step ordering behavio ## Usage ```yaml -- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@main +- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@bcbbcaff24e053e38ebab02dd0e41442df196719 # 0.32.0 with: - builder: ${{ steps.docker-setup.outputs.buildx-name }} + # Docker Buildx builder name to remove during post-job cleanup. + builder: "" + + # Whether cleanup should run during the post-job phase. + # Default: `true` enabled: true ``` @@ -68,3 +71,27 @@ Copyright © 2026 hoverkraft For more details, see the [license](http://choosealicense.com/licenses/mit/). + + +[![Marketplace](https://img.shields.io/badge/Marketplace-docker------cleanup--builder-blue?logo=github-actions)](https://github.com/marketplace/actions/docker---cleanup-builder) +[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-container)](https://github.com/hoverkraft-tech/ci-github-container/releases) +[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/) +[![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) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md) + + + + + + + + + + + + +--- + +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). + + diff --git a/actions/docker/setup/README.md b/actions/docker/setup/README.md index 98e56072..81b20bea 100644 --- a/actions/docker/setup/README.md +++ b/actions/docker/setup/README.md @@ -62,15 +62,15 @@ Shared action to configure Docker tooling and OCI registry authentication. # When provided, registry authentication targets are inferred from the built image data. built-images: "" - # Whether the Buildx builder should be removed during post-job cleanup. + # Whether to install and configure Docker Buildx. # # Default: `true` - buildx-cleanup: true + setup-buildx: true - # Whether to install and configure Docker Buildx. + # Whether the Buildx builder should be removed during post-job cleanup. # # Default: `true` - setup-buildx: true + buildx-cleanup: true ```` @@ -93,8 +93,8 @@ Shared action to configure Docker tooling and OCI registry authentication. | | 
[registry."my-registry.local:5000"]
 http = true
 insecure = true
| | | | **`built-images`** | Optional built images payload used to resolve manifest publication registries. | **false** | - | | | When provided, registry authentication targets are inferred from the built image data. | | | -| **`buildx-cleanup`** | Whether the Buildx builder should be removed during post-job cleanup. | **false** | `true` | | **`setup-buildx`** | Whether to install and configure Docker Buildx. | **false** | `true` | +| **`buildx-cleanup`** | Whether the Buildx builder should be removed during post-job cleanup. | **false** | `true` | diff --git a/actions/helm/test-chart/README.md b/actions/helm/test-chart/README.md index f5a1dec9..2ef1fc30 100644 --- a/actions/helm/test-chart/README.md +++ b/actions/helm/test-chart/README.md @@ -34,7 +34,7 @@ Mainly using [helm/chart-testing-action](https://github.com/helm/chart-testing-a ## Usage ````yaml -- uses: hoverkraft-tech/ci-github-container/actions/helm/test-chart@a0bab9151cc074af9f6c8204ab42a48d2d570379 # 0.30.6 +- uses: hoverkraft-tech/ci-github-container/actions/helm/test-chart@bcbbcaff24e053e38ebab02dd0e41442df196719 # 0.32.0 with: # Working directory # Default: `${{ github.workspace }}`