actions/setup-buildx-action
2
0
Fork 0
mirror of https://github.com/docker/setup-buildx-action.git synced 2025-03-31 08:46:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

add docs

Browse source
This commit is contained in:
Tobias Zürcher 2024-09-20 16:01:31 +02:00
parent 03082a18b1
commit fbf846733f
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -100,8 +100,8 @@ The following inputs can be used as `step.with` keys:
| `append` | YAML | | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder | | `append` | YAML | | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder |
| `cache-binary` | Bool | `true` | Cache buildx binary to GitHub Actions cache backend | | `cache-binary` | Bool | `true` | Cache buildx binary to GitHub Actions cache backend |
| `cleanup` | Bool | `true` | Cleanup temp files and remove builder at the end of a job | | `cleanup` | Bool | `true` | Cleanup temp files and remove builder at the end of a job |
| `keep-state` | Bool | `false` | Keep volume state on cleanup | | `keep-state` | Bool | `false` | Retain the Docker volume. Note that this functionality is exclusive to self-hosted runners. To reuse a volume, you must assign a specific name to the builder. |
| `name` | String | `false` | Builder name use use when creating the builder. If not specified, one will be generated. | | `name` | String | `false` | Providing a name allows for volume reuse on self-hosted runners. If a builder name is not specified, one will be automatically generated. |
_\* `buildkitd-config` and `buildkitd-config-inline` are mutually exclusive_ _\* `buildkitd-config` and `buildkitd-config-inline` are mutually exclusive_

6
action.yml
View file

@ -1,7 +1,7 @@
# https://help.github.com/en/articles/metadata-syntax-for-github-actions # https://help.github.com/en/articles/metadata-syntax-for-github-actions
name: 'Docker Setup Buildx with state' name: 'Docker Setup Buildx with state'
description: 'Set up Docker Buildx' description: 'Set up Docker Buildx'
author: 'tobiaszuercher' author: 'docker'
branding: branding:
icon: 'anchor' icon: 'anchor'
color: 'blue' color: 'blue'
@ -54,11 +54,11 @@ inputs:
required: false required: false
# TODO: remove deprecated config and config-inline inputs # TODO: remove deprecated config and config-inline inputs
keep-state: keep-state:
description: 'Keep state on cleanup. This only works on self-hosted runners. In order to reuse a buildkit volume, you need to specify a name for the builder.' description: 'Retain the Docker volume. Note that this functionality is exclusive to self-hosted runners. To reuse a volume, you must assign a specific name to the builder.'
default: 'false' default: 'false'
required: false required: false
name: name:
description: 'Builder name to use when creating the builder. If not specified, one will be generated. Specifying a name enables reusing a buildkit volume in persistent self-hosted runners.' description: 'Providing a name allows for volume reuse on self-hosted runners. If a builder name is not specified, one will be automatically generated.'
required: false required: false
config: config:
description: 'BuildKit daemon config file' description: 'BuildKit daemon config file'