2022-06-02 19:48:53 +00:00
---
properties :
2024-01-03 20:23:07 +00:00
- name : add_host
description : |
Additional `host:ip` mapping.
type : list
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : auto_tag
description : |
Generate tag names automatically based on git branch and git tag.
2022-06-02 19:48:53 +00:00
2024-01-03 20:23:07 +00:00
When this feature is enabled and the event type is `tag`, the plugin will automatically tag
the image using the standard semVer convention. For example :
- `1.0.0` produces docker tags `1`, `1.0`, `1.0.0`
- `1.0.0-rc.1` produces docker tags `1.0.0-rc.1`
When the event type is `push` and the target branch is your default branch, the plugin will
automatically tag the image as `latest`. All other event types and branches are ignored.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : auto_tag_suffix
description : |
Generate tag names with the given suffix.
2022-06-02 19:48:53 +00:00
type : string
required : false
2022-11-24 12:55:22 +00:00
- name : bip
2024-01-03 20:23:07 +00:00
description : |
Allow the docker daemon to bride IP address.
2022-06-02 19:48:53 +00:00
type : string
required : false
2024-01-03 20:23:07 +00:00
- name : build_args
description : |
Custom build arguments for the build.
2022-06-02 19:48:53 +00:00
type : list
required : false
2024-01-03 20:23:07 +00:00
- name : build_args_from_env
description : |
Forward environment variables as custom arguments to the build.
2022-06-02 19:48:53 +00:00
type : list
required : false
2022-11-24 12:55:22 +00:00
- name : buildkit_config
2023-01-08 13:41:49 +00:00
description : |
Content of the docker buildkit toml [config](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md). Example :
2023-06-29 19:30:58 +00:00
```yaml
steps :
- name : Build
2024-01-03 20:23:07 +00:00
image : quay.io/thegeeklab/wp-docker-buildx
2023-06-29 19:30:58 +00:00
settings :
repo : example/repo
buildkit_config : |
[ registry."registry.local:30081"]
http = true
insecure = true
2023-01-08 13:41:49 +00:00
```
2022-06-02 19:48:53 +00:00
type : string
required : false
2024-01-03 20:23:07 +00:00
- name : cache_from
2023-09-03 20:33:59 +00:00
description : |
2024-01-03 20:23:07 +00:00
Images to consider as [cache sources](https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-from). To properly work,
commas used in the cache source entries need to be escaped :
2023-09-03 20:33:59 +00:00
2024-01-03 20:23:07 +00:00
```yaml
steps :
- name : Build
image : quay.io/thegeeklab/wp-docker-buildx
settings :
repo : example/repo
cache_from :
# while using quotes, double-escaping is required
- "type=registry\\\\,ref=example"
- 'type=foo\\,ref=bar'
```
type : list
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : cache_to
description : |
[ Cache destination](https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-to) for the build cache.
2022-06-02 19:48:53 +00:00
type : string
required : false
2024-01-03 20:23:07 +00:00
- name : compress
description : |
Enable compression of the build context using gzip.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-07-24 10:48:02 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : config
description : |
Content of the docker daemon json config.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : $DOCKER_PLUGIN_CONFIG
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : containerfile
2022-06-02 19:48:53 +00:00
description : |
2024-01-03 20:23:07 +00:00
Containerfile to use for the image build.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : "Containerfile"
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : context
description : |
Path of the build context.
2022-06-02 19:48:53 +00:00
type : string
2024-01-03 22:26:12 +00:00
defaultValue : "."
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : custom_dns
2022-10-09 12:05:05 +00:00
description : |
2024-01-03 20:23:07 +00:00
Custom docker daemon dns server.
2022-10-09 12:05:05 +00:00
type : list
required : false
2024-01-03 20:23:07 +00:00
- name : custom_dns_search
description : |
Custom docker daemon dns search domain.
2022-06-02 19:48:53 +00:00
type : list
required : false
2024-01-03 20:23:07 +00:00
- name : daemon_off
description : |
Disable the startup of the docker daemon.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : debug
description : |
Enable verbose debug mode for the docker daemon.
2022-06-02 19:48:53 +00:00
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : dry_run
description : |
Disable docker push.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : email
2022-11-01 20:49:13 +00:00
description : |
2024-01-03 20:23:07 +00:00
Email address for registry authentication.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : $DOCKER_EMAIL
2024-01-03 20:23:07 +00:00
required : false
2022-11-01 20:49:13 +00:00
2024-01-03 20:23:07 +00:00
- name : experimental
description : |
Enable docker daemon experimental mode.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : extra_tags
2022-08-21 20:47:59 +00:00
description : |
2024-01-03 20:23:07 +00:00
Additional tags to use for the image including registry.
Additional tags can also be loaded from an `.extratags` file. This function can be used to push
images to multiple registries at once. Therefore, it is necessary to use the `config` flag to
provide a configuration file that contains the authentication information for all used registries.
type : list
2022-08-08 11:36:23 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : insecure
description : |
Allow the docker daemon to use insecure registries.
2022-06-02 19:48:53 +00:00
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-05-05 11:03:50 +00:00
- name : insecure_skip_verify
description : |
Skip SSL verification.
type : bool
defaultValue : false
required : false
2024-01-03 20:23:07 +00:00
- name : ipv6
description : |
Enable docker daemon IPv6 support.
2022-06-02 19:48:53 +00:00
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : labels
2022-06-02 19:48:53 +00:00
description : |
2024-01-03 20:23:07 +00:00
Labels to add to image.
type : list
2022-06-02 19:48:53 +00:00
required : false
2024-05-05 11:03:50 +00:00
- name : log_level
description : |
Plugin log level.
type : string
defaultValue : "info"
required : false
2024-01-03 20:23:07 +00:00
- name : max_concurrent_uploads
2022-12-21 08:54:17 +00:00
description : |
2024-01-03 20:23:07 +00:00
Max concurrent uploads for each push.
By default the Docker daemon will push five layers of an image at a time. If you are on a low bandwidth connection this may cause
timeout issues and you may want to lower with this option.
2023-08-11 08:10:32 +00:00
type : string
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : mirror
description : |
Registry mirror to pull images.
2022-06-02 19:48:53 +00:00
type : string
2024-01-03 22:26:12 +00:00
defaultValue : $DOCKER_PLUGIN_MIRROR
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : mtu
description : |
Docker daemon custom MTU setting.
2022-06-02 19:48:53 +00:00
type : string
required : false
2024-01-03 20:23:07 +00:00
- name : named_context
description : |
Additional named [build contexts](https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context) (format : `name=path`).
type : list
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : no_cache
description : |
Disable the usage of cached intermediate containers.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : output
description : |
[ Export action](https://docs.docker.com/engine/reference/commandline/buildx_build/#output) for the build result
(format : `path` or `type=TYPE[,KEY=VALUE]`).
2022-06-02 19:48:53 +00:00
type : string
required : false
2024-01-03 20:23:07 +00:00
- name : password
description : |
Password for registry authentication.
2022-06-02 19:48:53 +00:00
type : string
2024-01-03 22:26:12 +00:00
defaultValue : $DOCKER_PASSWORD
2022-06-02 19:48:53 +00:00
required : false
2024-01-03 20:23:07 +00:00
- name : platforms
description : |
Target platform for build.
2022-06-02 19:48:53 +00:00
type : list
required : false
2024-01-03 20:23:07 +00:00
- name : provenance
description : |
Generate [provenance](https://docs.docker.com/build/attestations/slsa-provenance/) attestation for the build (shorthand for `--attest=type=provenance`).
type : string
2022-06-02 19:48:53 +00:00
required : false
2022-09-20 19:35:29 +00:00
2024-01-03 20:23:07 +00:00
- name : pull_image
description : |
Enforce to pull base image at build time.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : true
2022-09-20 19:35:29 +00:00
required : false
2023-01-12 10:28:22 +00:00
2024-01-03 20:23:07 +00:00
- name : quiet
description : |
Enable suppression of the build output.
type : bool
2024-01-03 22:26:12 +00:00
defaultValue : false
2024-01-03 20:23:07 +00:00
required : false
- name : registry
description : |
Docker registry to authenticate with.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : "https://index.docker.io/v1/"
2024-01-03 20:23:07 +00:00
required : false
- name : repo
description : |
Repository name for the image.
If the image is to be pushed to registries other than the default DockerHub,
it is necessary to set `repo` as fully-qualified name.
2023-01-12 10:28:22 +00:00
type : string
required : false
2023-03-08 14:51:24 +00:00
- name : sbom
2024-01-03 20:23:07 +00:00
description : |
Generate [SBOM](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest type=sbom`).
2023-03-08 14:51:24 +00:00
type : string
required : false
2023-06-28 18:26:07 +00:00
- name : secrets
2023-06-29 19:30:58 +00:00
description : |
Exposes [secrets](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret) to the build.
The secrets can be used by the build using `RUN --mount=type=secret` mount.
```yaml
steps :
- name : Build
2024-01-03 20:23:07 +00:00
image : quay.io/thegeeklab/wp-docker-buildx
2023-06-29 19:30:58 +00:00
privileged : true
environment :
SECURE_TOKEN :
from_secret : secure_token
settings :
secrets :
# while using quotes, double-escaping is required
- "id=raw_file_secret\\\\,src=file.txt"
- 'id=other_raw_file_secret\\,src=other_file.txt'
- "id=SECRET_TOKEN"
```
2023-08-29 07:06:19 +00:00
To use secrets from files a [host volume](https://woodpecker-ci.org/docs/usage/volumes) is required.
2023-06-29 19:30:58 +00:00
This should be used with caution and avoided whenever possible.
2023-06-28 18:26:07 +00:00
type : list
required : false
2024-01-03 20:23:07 +00:00
- name : storage_driver
description : |
Docker daemon storage driver.
type : string
required : false
- name : storage_path
description : |
Docker daemon storage path.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : "/var/lib/docker"
2024-01-03 20:23:07 +00:00
required : false
- name : tags
description : |
Repository tags to use for the image.
Tags can also be loaded from a `.tags` file.
type : list
required : false
- name : target
description : |
Build target to use.
type : string
required : false
- name : username
description : |
Username for registry authentication.
type : string
2024-01-03 22:26:12 +00:00
defaultValue : $DOCKER_USERNAME
2024-01-03 20:23:07 +00:00
required : false