From 68d9835800ce009297620610ad1432fea248c8bd Mon Sep 17 00:00:00 2001 From: thegeeklab-bot Date: Wed, 3 Jan 2024 20:35:24 +0000 Subject: [PATCH] [skip ci] auto-update documentation --- content/_index.md | 6 +- data/data.yaml | 428 ++++++++++++++++++++++++++-------------------- 2 files changed, 241 insertions(+), 193 deletions(-) diff --git a/content/_index.md b/content/_index.md index 69439e1..2af42e9 100644 --- a/content/_index.md +++ b/content/_index.md @@ -30,7 +30,7 @@ name: default steps: - name: docker - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx privileged: true settings: username: octocat @@ -61,7 +61,7 @@ name: default steps: - name: docker - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx privileged: true settings: registry: ghcr.io @@ -79,7 +79,7 @@ name: default steps: - name: docker - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx privileged: true environment: AWS_ACCESS_KEY_ID: diff --git a/data/data.yaml b/data/data.yaml index efc2b38..fab163e 100644 --- a/data/data.yaml +++ b/data/data.yaml @@ -1,76 +1,49 @@ --- properties: - - name: dry_run - description: Disable docker push. + - name: add_host + 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 + defaultvalue: false required: false - - name: mirror - description: Use a registry mirror to pull images. - type: string - 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 + - name: auto_tag_suffix + description: | + Generate tag names with the given suffix. type: string required: false - name: bip - description: Allows the docker daemon to bride IP address. + description: | + Allow the docker daemon to bride IP address. type: string required: false - - name: mtu - description: A docker daemon custom MTU. - type: string - required: false - - - name: custom_dns - description: Custom docker daemon DNS server. + - name: build_args + description: | + Custom build arguments for the build. type: list required: false - - name: custom_dns_search - description: Custom docker daemon DNS search domain. + - name: build_args_from_env + description: | + Forward environment variables as custom arguments to the build. type: list 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 description: | 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 steps: - name: Build - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx settings: repo: example/repo buildkit_config: | @@ -87,83 +60,6 @@ properties: insecure = true ``` 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 - name: cache_from @@ -174,7 +70,7 @@ properties: ```yaml steps: - name: Build - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx settings: repo: example/repo cache_from: @@ -191,87 +87,205 @@ properties: type: string required: false - - name: pull_image - description: Enforce to pull the base image at build time. - defaultValue: true + - name: compress + description: | + Enable compression of the build context using gzip. type: bool + defaultvalue: false required: false - - name: compress - description: Enable compression of the build context using gzip. - defaultValue: false + - name: config + description: | + 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 + 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 - 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]`). - 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 required: false - name: password - description: Password for authentication with the registry. + description: | + Password for registry authentication. type: string - required: false - - - 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 + defaultvalue: $DOCKER_PASSWORD required: false - name: platforms - description: Target platforms for build. - type: list - required: false - - - name: labels - description: Labels to add to the image. + description: | + Target platform for build. type: list required: false - 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 required: false - 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 required: false @@ -283,7 +297,7 @@ properties: ```yaml steps: - name: Build - image: thegeeklab/wp-docker-buildx:23 + image: quay.io/thegeeklab/wp-docker-buildx privileged: true environment: SECURE_TOKEN: @@ -300,3 +314,37 @@ properties: This should be used with caution and avoided whenever possible. type: list 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