2020-08-18 17:40:31 +02:00
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
2024-09-19 16:41:12 +02:00
name : 'Docker Setup Buildx with state'
2020-08-18 17:40:31 +02:00
description : 'Set up Docker Buildx'
2024-09-19 16:39:57 +02:00
author : 'tobiaszuercher'
2020-08-18 17:40:31 +02:00
branding :
icon : 'anchor'
color : 'blue'
inputs :
version :
2020-09-06 16:37:52 +02:00
description : 'Buildx version. (eg. v0.3.0)'
2020-08-18 17:40:31 +02:00
required : false
driver :
description : 'Sets the builder driver to be used'
default : 'docker-container'
required : false
2020-09-03 16:23:15 +02:00
driver-opts :
2020-09-06 16:37:52 +02:00
description : 'List of additional driver-specific options. (eg. image=moby/buildkit:master)'
2020-08-18 17:40:31 +02:00
required : false
buildkitd-flags :
2024-03-01 08:57:18 +01:00
description : 'BuildKit daemon flags'
2020-09-03 20:38:04 +02:00
default : '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host'
2020-08-18 17:40:31 +02:00
required : false
2024-03-01 08:57:18 +01:00
buildkitd-config :
description : 'BuildKit daemon config file'
required : false
buildkitd-config-inline :
description : 'Inline BuildKit daemon config'
required : false
2020-08-18 17:40:31 +02:00
install :
2022-05-26 18:18:23 -04:00
description : 'Sets up docker build command as an alias to docker buildx build'
2020-08-18 17:40:31 +02:00
default : 'false'
required : false
use :
description : 'Switch to this builder instance'
default : 'true'
required : false
2020-09-08 15:52:09 +02:00
endpoint :
2020-09-08 18:22:35 +02:00
description : 'Optional address for docker socket or context from `docker context ls`'
2020-09-06 16:37:52 +02:00
required : false
2022-09-22 11:54:00 +02:00
platforms :
description : 'Fixed platforms for current node. If not empty, values take priority over the detected ones'
required : false
2022-09-19 11:34:47 +02:00
append :
description : 'Append additional nodes to the builder'
required : false
2024-02-23 10:51:47 +01:00
cache-binary :
description : 'Cache buildx binary to GitHub Actions cache backend'
default : 'true'
required : false
2023-03-03 11:56:21 +01:00
cleanup :
description : 'Cleanup temp files and remove builder at the end of a job'
default : 'true'
required : false
2024-07-05 13:17:52 +02:00
# TODO: remove deprecated config and config-inline inputs
2024-09-19 16:37:29 +02:00
keep-state :
2024-09-20 14:42:27 +02:00
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.'
2024-09-19 16:37:29 +02:00
default : 'false'
required : false
name :
2024-09-20 14:42:27 +02:00
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.'
2024-09-19 16:37:29 +02:00
required : false
2024-03-01 08:57:18 +01:00
config :
description : 'BuildKit daemon config file'
deprecationMessage : 'Use buildkitd-config instead'
required : false
config-inline :
description : 'Inline BuildKit daemon config'
deprecationMessage : 'Use buildkitd-config-inline instead'
required : false
2020-08-18 17:40:31 +02:00
outputs :
name :
2021-04-23 18:14:38 +02:00
description : 'Builder name'
driver :
description : 'Builder driver'
2022-09-18 02:24:38 +02:00
platforms :
description : 'Builder node platforms (preferred or available)'
nodes :
description : 'Builder nodes metadata'
2021-04-23 18:14:38 +02:00
endpoint :
2022-09-18 02:24:38 +02:00
description : 'Builder node endpoint (deprecated, use nodes output instead)'
2021-04-23 18:14:38 +02:00
status :
2022-09-18 02:24:38 +02:00
description : 'Builder node status (deprecated, use nodes output instead)'
2021-04-23 18:14:38 +02:00
flags :
2022-09-18 02:24:38 +02:00
description : 'Builder node flags (deprecated, use nodes output instead)'
2020-08-18 17:40:31 +02:00
runs :
2023-09-07 12:43:56 +02:00
using : 'node20'
2020-08-18 17:40:31 +02:00
main : 'dist/index.js'
post : 'dist/index.js'