Skip to content

Commit 5c4f72a

Browse files
docs(hoverkraft-tech/ci-github-container): update documentation
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent cdcd1df commit 5c4f72a

File tree

20 files changed

+182
-68
lines changed

20 files changed

+182
-68
lines changed

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
source_repo: hoverkraft-tech/ci-github-container
33
source_path: CONTRIBUTING.md
44
source_branch: main
5-
source_run_id: 24227868893
6-
last_synced: 2026-04-10T05:29:38.456Z
5+
source_run_id: 24253765536
6+
last_synced: 2026-04-10T16:51:50.902Z
77
---
88

99
# Contributing

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ description: Documentation for Ci Github Container
88
Documentation for the Ci Github Container project.
99

1010
**Source Repository:** [hoverkraft-tech/ci-github-container](https://github.com/hoverkraft-tech/ci-github-container)
11-
**Last Synced:** 2026-04-10T05:29:38.456Z
11+
**Last Synced:** 2026-04-10T16:51:50.902Z

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/build-image/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Build Image
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/build-image/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/clean-images/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Clean Images
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/clean-images/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: Cleanup Builder
3+
source_repo: hoverkraft-tech/ci-github-container
4+
source_path: actions/docker/cleanup-builder/README.md
5+
source_branch: main
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
8+
---
9+
10+
<!-- header:start -->
11+
12+
# ![Icon](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGNsYXNzPSJmZWF0aGVyIGZlYXRoZXItdHJhc2gtMiIgY29sb3I9ImJsdWUiPjxwb2x5bGluZSBwb2ludHM9IjMgNiA1IDYgMjEgNiI+PC9wb2x5bGluZT48cGF0aCBkPSJNMTkgNnYxNGEyIDIgMCAwIDEtMiAySDdhMiAyIDAgMCAxLTItMlY2bTMgMFY0YTIgMiAwIDAgMSAyLTJoNGEyIDIgMCAwIDEgMiAydjIiPjwvcGF0aD48bGluZSB4MT0iMTAiIHkxPSIxMSIgeDI9IjEwIiB5Mj0iMTciPjwvbGluZT48bGluZSB4MT0iMTQiIHkxPSIxMSIgeDI9IjE0IiB5Mj0iMTciPjwvbGluZT48L3N2Zz4=) GitHub Action: Docker - Cleanup builder
13+
14+
<div align="center">
15+
<img src="/ci-github-container/assets/github/logo.svg" width="60px" align="center" alt="Docker - Cleanup builder" />
16+
</div>
17+
18+
---
19+
20+
<!-- header:end -->
21+
<!-- overview:start -->
22+
23+
## Overview
24+
25+
Register a post-job step that removes a Docker Buildx builder after later post steps have finished.
26+
27+
<!-- overview:end -->
28+
<!-- usage:start -->
29+
30+
## Usage
31+
32+
```yaml
33+
- uses: hoverkraft-tech/ci-github-container/actions/docker/cleanup-builder@bcbbcaff24e053e38ebab02dd0e41442df196719 # 0.32.0
34+
with:
35+
# Docker Buildx builder name to remove during post-job cleanup.
36+
builder: ""
37+
38+
# Whether cleanup should run during the post-job phase.
39+
# Default: `true`
40+
enabled: true
41+
```
42+
43+
<!-- usage:end -->
44+
<!-- inputs:start -->
45+
46+
## Inputs
47+
48+
| **Input** | **Description** | **Required** | **Default** |
49+
| ------------- | ------------------------------------------------------------- | ------------ | ----------- |
50+
| **`builder`** | Docker Buildx builder name to remove during post-job cleanup. | **false** | - |
51+
| **`enabled`** | Whether cleanup should run during the post-job phase. | **false** | `true` |
52+
53+
<!-- inputs:end -->
54+
55+
## Notes
56+
57+
Use this action before other actions whose post-job hooks still need the builder. It is intended as a workaround for GitHub Actions runner behavior around post-step ordering in composite actions. See [actions/runner#1657](https://github.com/actions/runner/issues/1657).
58+
59+
In practice, this means the built-in `docker/setup-buildx-action` cleanup can run too early for actions such as `docker/build-push-action` or `reproducible-containers/buildkit-cache-dance` that still access the builder during their own post-job hooks.
60+
61+
This action works by registering its cleanup post hook earlier, so the runner executes it later than the post hooks that still need the builder.
62+
63+
<!-- contributing:start -->
64+
65+
## Contributing
66+
67+
Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md) for more details.
68+
69+
<!-- contributing:end -->
70+
<!-- license:start -->
71+
72+
## License
73+
74+
This project is licensed under the MIT License.
75+
76+
SPDX-License-Identifier: MIT
77+
78+
Copyright © 2026 hoverkraft
79+
80+
For more details, see the [license](http://choosealicense.com/licenses/mit/).
81+
82+
<!-- license:end -->
83+
<!-- badges:start -->
84+
85+
[![Marketplace](https://img.shields.io/badge/Marketplace-docker------cleanup--builder-blue?logo=github-actions)](https://github.com/marketplace/actions/docker---cleanup-builder)
86+
[![Release](https://img.shields.io/github/v/release/hoverkraft-tech/ci-github-container)](https://github.com/hoverkraft-tech/ci-github-container/releases)
87+
[![License](https://img.shields.io/github/license/hoverkraft-tech/ci-github-container)](http://choosealicense.com/licenses/mit/)
88+
[![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)
89+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hoverkraft-tech/ci-github-container/blob/main/CONTRIBUTING.md)
90+
91+
<!-- badges:end -->
92+
<!-- secrets:start -->
93+
<!-- secrets:end -->
94+
<!-- outputs:start -->
95+
<!-- outputs:end -->
96+
<!-- examples:start -->
97+
<!-- examples:end -->
98+
<!-- security:start -->
99+
<!-- security:end -->
100+
<!-- generated:start -->
101+
102+
---
103+
104+
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
105+
106+
<!-- generated:end -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/create-images-manifests/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Create Images Manifests
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/create-images-manifests/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-metadata/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Get Image Metadata
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/get-image-metadata/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/get-image-name/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Get Image Name
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/get-image-name/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/prune-pull-requests-image-tags/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Prune Pull Requests Image Tags
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/prune-pull-requests-image-tags/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->

application/docs/projects/github-actions-and-reusable-workflows/ci-github-container/actions/docker/setup/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Setup
33
source_repo: hoverkraft-tech/ci-github-container
44
source_path: actions/docker/setup/README.md
55
source_branch: main
6-
source_run_id: 24227868893
7-
last_synced: 2026-04-10T05:29:38.456Z
6+
source_run_id: 24253765536
7+
last_synced: 2026-04-10T16:51:50.902Z
88
---
99

1010
<!-- header:start -->
@@ -75,6 +75,11 @@ Shared action to configure Docker tooling and OCI registry authentication.
7575
#
7676
# Default: `true`
7777
setup-buildx: true
78+
79+
# Whether the Buildx builder should be removed during post-job cleanup.
80+
#
81+
# Default: `true`
82+
buildx-cleanup: true
7883
````
7984

8085
<!-- usage:end -->
@@ -98,6 +103,7 @@ Shared action to configure Docker tooling and OCI registry authentication.
98103
| **`built-images`** | Optional built images payload used to resolve manifest publication registries. | **false** | - |
99104
| | When provided, registry authentication targets are inferred from the built image data. | | |
100105
| **`setup-buildx`** | Whether to install and configure Docker Buildx. | **false** | `true` |
106+
| **`buildx-cleanup`** | Whether the Buildx builder should be removed during post-job cleanup. | **false** | `true` |
101107

102108
<!-- inputs:end -->
103109

0 commit comments

Comments
 (0)