From fbf846733feac8dfc3d3efa1229a21e32f682e1c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tobias=20Z=C3=BCrcher?= <tobias.zuercher@gmail.com>
Date: Fri, 20 Sep 2024 16:01:31 +0200
Subject: [PATCH] add docs
---
README.md | 4 ++--
action.yml | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 6dd2df9..383ee32 100644
--- a/README.md
+++ b/README.md
@@ -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 |
| `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 |
-| `keep-state` | Bool | `false` | Keep volume state on cleanup |
-| `name` | String | `false` | Builder name use use when creating the builder. If not specified, one will be generated. |
+| `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` | 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_
diff --git a/action.yml b/action.yml
index f6abc68..0c1ad31 100644
--- a/action.yml
+++ b/action.yml
@@ -1,7 +1,7 @@
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
name: 'Docker Setup Buildx with state'
description: 'Set up Docker Buildx'
-author: 'tobiaszuercher'
+author: 'docker'
branding:
icon: 'anchor'
color: 'blue'
@@ -54,11 +54,11 @@ inputs:
required: false
# TODO: remove deprecated config and config-inline inputs
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'
required: false
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
config:
description: 'BuildKit daemon config file'