github/wp-docker-buildx
0
0
Fork 0
mirror of https://github.com/thegeeklab/wp-docker-buildx.git synced 2024-11-14 19:10:41 +00:00
Code Issues Releases Activity

[skip ci] auto-update documentation

Browse Source
This commit is contained in:
thegeeklab-bot 2024-01-03 20:35:24 +00:00
parent efd2b8247c
commit 68d9835800
2 changed files with 241 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/_index.md
View File

@ -30,7 +30,7 @@ name: default
steps: steps:
- name: docker - name: docker
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
privileged: true privileged: true
settings: settings:
username: octocat username: octocat
@ -61,7 +61,7 @@ name: default
steps: steps:
- name: docker - name: docker
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
privileged: true privileged: true
settings: settings:
registry: ghcr.io registry: ghcr.io
@ -79,7 +79,7 @@ name: default
steps: steps:
- name: docker - name: docker
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
privileged: true privileged: true
environment: environment:
AWS_ACCESS_KEY_ID: AWS_ACCESS_KEY_ID:

428
data/data.yaml
View File

@ -1,76 +1,49 @@
--- ---
properties: properties:
- name: dry_run - name: add_host
description: Disable docker push. description: |
Additional `host:ip` mapping.
type: list
required: false
- name: auto_tag
description: |
Generate tag names automatically based on git branch and git tag.
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 type: bool
defaultvalue: false
required: false required: false
- name: mirror - name: auto_tag_suffix
description: Use a registry mirror to pull images. description: |
type: string Generate tag names with the given suffix.
required: false
- name: storage_driver
description: The docker daemon storage driver.
type: string
required: false
- name: storage_path
description: The docker daemon storage path.
defaultValue: /var/lib/docker
type: string type: string
required: false required: false
- name: bip - name: bip
description: Allows the docker daemon to bride IP address. description: |
Allow the docker daemon to bride IP address.
type: string type: string
required: false required: false
- name: mtu - name: build_args
description: A docker daemon custom MTU. description: |
type: string Custom build arguments for the build.
required: false
- name: custom_dns
description: Custom docker daemon DNS server.
type: list type: list
required: false required: false
- name: custom_dns_search - name: build_args_from_env
description: Custom docker daemon DNS search domain. description: |
Forward environment variables as custom arguments to the build.
type: list type: list
required: false required: false
- name: insecure
description: Enable the usage of insecure registries.
type: bool
defaultValue: false
required: false
- name: ipv6
description: Enable docker daemon IPv6 support.
type: bool
defaultValue: false
required: false
- name: experimental
description: Enable docker daemon experimental mode.
type: bool
defaultValue: false
required: false
- name: debug
description: Enable verbose debug mode for the docker daemon.
type: string
defaultValue: false
required: false
- name: daemon_off
description: Disable the startup of the docker daemon.
type: string
defaultValue: false
required: false
- name: buildkit_config - name: buildkit_config
description: | description: |
Content of the docker buildkit toml [config](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md). Example: Content of the docker buildkit toml [config](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md). Example:
@ -78,7 +51,7 @@ properties:
```yaml ```yaml
steps: steps:
- name: Build - name: Build
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
settings: settings:
repo: example/repo repo: example/repo
buildkit_config: | buildkit_config: |
@ -87,83 +60,6 @@ properties:
insecure = true insecure = true
``` ```
type: string type: string
defaultValue: false
required: false
- name: max_concurrent_uploads
description: |
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.
type: string
required: false
- name: containerfile
description: Set the containerfile to use for the image build.
defaultValue: Containerfile
type: string
required: false
- name: context
description: Set the path of the build context to use.
defaultValue: .
type: string
required: false
- name: named_context
description: Set additional named [build contexts](https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context) (e.g., name=path).
type: list
required: false
- name: tags
description: Set repository tags to use for the image. Tags can also be loaded from a `.tags` file.
defaultValue: latest
type: list
required: false
- name: auto_tag
description: |
Generate tag names automatically based on git branch and git tag. 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.
defaultValue: false
type: bool
required: false
- name: auto_tag_suffix
description: Generate tag names with the given suffix.
type: string
required: false
- name: extra_tags
description: |
Set additional tags to be used for the image. 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
required: false
- name: build_args
description: Custom build arguments to pass to the build.
type: list
required: false
- name: build_args_from_env
description: Forward environment variables as custom arguments to the build.
type: list
required: false
- name: quiet
description: Enable suppression of the build output.
defaultValue: false
type: bool
required: false
- name: target
description: The docker build target.
type: string
required: false required: false
- name: cache_from - name: cache_from
@ -174,7 +70,7 @@ properties:
```yaml ```yaml
steps: steps:
- name: Build - name: Build
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
settings: settings:
repo: example/repo repo: example/repo
cache_from: cache_from:
@ -191,87 +87,205 @@ properties:
type: string type: string
required: false required: false
- name: pull_image - name: compress
description: Enforce to pull the base image at build time. description: |
defaultValue: true Enable compression of the build context using gzip.
type: bool type: bool
defaultvalue: false
required: false required: false
- name: compress - name: config
description: Enable compression of the build context using gzip. description: |
defaultValue: false Content of the docker daemon json config.
type: string
defaultvalue: $DOCKER_PLUGIN_CONFIG
required: false
- name: containerfile
description: |
Containerfile to use for the image build.
type: string
defaultvalue: "Containerfile"
required: false
- name: context
description: |
Path of the build context.
type: string
defaultvalue: "."
required: false
- name: custom_dns
description: |
Custom docker daemon dns server.
type: list
required: false
- name: custom_dns_search
description: |
Custom docker daemon dns search domain.
type: list
required: false
- name: daemon_off
description: |
Disable the startup of the docker daemon.
type: bool type: bool
defaultvalue: false
required: false
- name: debug
description: |
Enable verbose debug mode for the docker daemon.
type: bool
defaultvalue: false
required: false
- name: dry_run
description: |
Disable docker push.
type: bool
defaultvalue: false
required: false
- name: email
description: |
Email address for registry authentication.
type: string
defaultvalue: $DOCKER_EMAIL
required: false
- name: experimental
description: |
Enable docker daemon experimental mode.
type: bool
defaultvalue: false
required: false
- name: extra_tags
description: |
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
required: false
- name: insecure
description: |
Allow the docker daemon to use insecure registries.
type: bool
defaultvalue: false
required: false
- name: ipv6
description: |
Enable docker daemon IPv6 support.
type: bool
defaultvalue: false
required: false
- name: labels
description: |
Labels to add to image.
type: list
required: false
- name: max_concurrent_uploads
description: |
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.
type: string
required: false
- name: mirror
description: |
Registry mirror to pull images.
type: string
defaultvalue: $DOCKER_PLUGIN_MIRROR
required: false
- name: mtu
description: |
Docker daemon custom MTU setting.
type: string
required: false
- name: named_context
description: |
Additional named [build contexts](https://docs.docker.com/engine/reference/commandline/buildx_build/#build-context) (format: `name=path`).
type: list
required: false
- name: no_cache
description: |
Disable the usage of cached intermediate containers.
type: bool
defaultvalue: false
required: false required: false
- name: output - name: output
description: | description: |
[Export action](https://docs.docker.com/engine/reference/commandline/buildx_build/#output) for the build result [Export action](https://docs.docker.com/engine/reference/commandline/buildx_build/#output) for the build result
(format: `path` or `type=TYPE[,KEY=VALUE]`). (format: `path` or `type=TYPE[,KEY=VALUE]`).
defaultValue: false
type: bool
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.
type: string
required: false
- name: registry
description: Docker registry to upload images.
defaultValue: https://index.docker.io/v1/
type: string
required: false
- name: username
description: Username for authentication with the registry.
type: string type: string
required: false required: false
- name: password - name: password
description: Password for authentication with the registry. description: |
Password for registry authentication.
type: string type: string
required: false defaultvalue: $DOCKER_PASSWORD
- name: email
description: E-Mail address for authentication with the registry.
type: string
required: false
- name: config
description: Content of the docker daemon json config.
type: string
required: false
- name: no_cache
description: Disable the usage of cached intermediate containers.
defaultValue: false
type: string
required: false
- name: add_host
description: Additional `host:ip` mapping.
type: list
required: false required: false
- name: platforms - name: platforms
description: Target platforms for build. description: |
type: list Target platform for build.
required: false
- name: labels
description: Labels to add to the image.
type: list type: list
required: false required: false
- name: provenance - name: provenance
description: Generate [provenance](https://docs.docker.com/build/attestations/slsa-provenance/) attestation for the build (shorthand for `--attest=type=provenance`). description: |
Generate [provenance](https://docs.docker.com/build/attestations/slsa-provenance/) attestation for the build (shorthand for `--attest=type=provenance`).
type: string
required: false
- name: pull_image
description: |
Enforce to pull base image at build time.
type: bool
defaultvalue: true
required: false
- name: quiet
description: |
Enable suppression of the build output.
type: bool
defaultvalue: false
required: false
- name: registry
description: |
Docker registry to authenticate with.
type: string
defaultvalue: "https://index.docker.io/v1/"
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.
type: string type: string
required: false required: false
- name: sbom - name: sbom
description: Generate [sbom](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest type=sbom`). description: |
Generate [SBOM](https://docs.docker.com/build/attestations/sbom/) attestation for the build (shorthand for `--attest type=sbom`).
type: string type: string
required: false required: false
@ -283,7 +297,7 @@ properties:
```yaml ```yaml
steps: steps:
- name: Build - name: Build
image: thegeeklab/wp-docker-buildx:23 image: quay.io/thegeeklab/wp-docker-buildx
privileged: true privileged: true
environment: environment:
SECURE_TOKEN: SECURE_TOKEN:
@ -300,3 +314,37 @@ properties:
This should be used with caution and avoided whenever possible. This should be used with caution and avoided whenever possible.
type: list type: list
required: false required: false
- name: storage_driver
description: |
Docker daemon storage driver.
type: string
required: false
- name: storage_path
description: |
Docker daemon storage path.
type: string
defaultvalue: "/var/lib/docker"
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
defaultvalue: $DOCKER_USERNAME
required: false