From 1e6dee0e0b2db1a446984aad846429dba47f78f0 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Tue, 19 Dec 2023 13:39:15 +0100 Subject: [PATCH] readme: move subactions docs Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com> --- README.md | 92 +++++++++++++++++++++++++++---------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 9f99cf8..979ac84 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ as a high-level build command. ___ * [Usage](#usage) -* [Subactions](#subactions) - * [`list-targets`](#list-targets) * [Customizing](#customizing) * [inputs](#inputs) * [outputs](#outputs) +* [Subactions](#subactions) + * [`list-targets`](#list-targets) * [Contributing](#contributing) ## Usage @@ -54,6 +54,50 @@ jobs: push: true ``` +## Customizing + +### inputs + +Following inputs can be used as `step.with` keys + +> `List` type is a newline-delimited string +> ```yaml +> set: target.args.mybuildarg=value +> ``` +> ```yaml +> set: | +> target.args.mybuildarg=value +> foo*.args.mybuildarg=value +> ``` + +> `CSV` type is a comma-delimited string +> ```yaml +> targets: default,release +> ``` + +| Name | Type | Description | +|--------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) | +| `files` | List/CSV | List of [bake definition files](https://docs.docker.com/build/customize/bake/file-definition/) | +| `workdir` | String | Working directory of execution | +| `targets` | List/CSV | List of bake targets (`default` target used if empty) | +| `no-cache` | Bool | Do not use cache when building the image (default `false`) | +| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) | +| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) | +| `provenance` | Bool/String | [Provenance](https://docs.docker.com/build/attestations/slsa-provenance/) is a shorthand for `--set=*.attest=type=provenance` | +| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) | +| `sbom` | Bool/String | [SBOM](https://docs.docker.com/build/attestations/sbom/) is a shorthand for `--set=*.attest=type=sbom` | +| `set` | List | List of [targets values to override](https://docs.docker.com/engine/reference/commandline/buildx_bake/#set) (eg: `targetpattern.key=value`) | +| `source` | String | [Remote bake definition](https://docs.docker.com/build/customize/bake/file-definition/#remote-definition) to build from | + +### outputs + +The following outputs are available + +| Name | Type | Description | +|------------|------|-----------------------| +| `metadata` | JSON | Build result metadata | + ## Subactions ### `list-targets` @@ -127,50 +171,6 @@ The following outputs are available |------------|----------|----------------------------| | `targets` | List/CSV | List of extracted targest | -## Customizing - -### inputs - -Following inputs can be used as `step.with` keys - -> `List` type is a newline-delimited string -> ```yaml -> set: target.args.mybuildarg=value -> ``` -> ```yaml -> set: | -> target.args.mybuildarg=value -> foo*.args.mybuildarg=value -> ``` - -> `CSV` type is a comma-delimited string -> ```yaml -> targets: default,release -> ``` - -| Name | Type | Description | -|--------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| -| `builder` | String | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) | -| `files` | List/CSV | List of [bake definition files](https://docs.docker.com/build/customize/bake/file-definition/) | -| `workdir` | String | Working directory of execution | -| `targets` | List/CSV | List of bake targets (`default` target used if empty) | -| `no-cache` | Bool | Do not use cache when building the image (default `false`) | -| `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) | -| `load` | Bool | Load is a shorthand for `--set=*.output=type=docker` (default `false`) | -| `provenance` | Bool/String | [Provenance](https://docs.docker.com/build/attestations/slsa-provenance/) is a shorthand for `--set=*.attest=type=provenance` | -| `push` | Bool | Push is a shorthand for `--set=*.output=type=registry` (default `false`) | -| `sbom` | Bool/String | [SBOM](https://docs.docker.com/build/attestations/sbom/) is a shorthand for `--set=*.attest=type=sbom` | -| `set` | List | List of [targets values to override](https://docs.docker.com/engine/reference/commandline/buildx_bake/#set) (eg: `targetpattern.key=value`) | -| `source` | String | [Remote bake definition](https://docs.docker.com/build/customize/bake/file-definition/#remote-definition) to build from | - -### outputs - -The following outputs are available - -| Name | Type | Description | -|------------|------|-----------------------| -| `metadata` | JSON | Build result metadata | - ## Contributing Want to contribute? Awesome! You can find information about contributing to