Skip to content

Commit de97931

Browse files
docs(classic/build): document progress option (#1378)
1 parent d8911c5 commit de97931

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

_docs/pipelines/steps/build.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ step_name:
115115
| `ssh` | Available when using [Buildkit](#buildkit-support) for ssh keys. See [more info](https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh){:target="\_blank"}| Optional |
116116
| `secrets` | Available when using [Buildkit](#buildkit-support) for secret mounting. See [more info](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret){:target="\_blank"}| Optional |
117117
| `platform` | The [target platform or platforms](https://docs.docker.com/build/building/multi-platform/){:target="\_blank"} to which to push the image. For example, `linux/amd64`. To target multiple platforms, separate them with commas, as in `linux/amd64,linux/arm64`. <br>NOTE: To use this property, you must enable `buildx`. | Optional |
118+
| `progress` | Set type of progress output. Available options: `auto` \| `quiet` \| `plain` \| `tty` \| `rawjson`. Defaults to `plain`. If specified, BuildKit will be enabled implicitly. | Optional |
118119
| `buildx` |Build and push Docker images, including multi-platform images, with <a href="https://github.com/docker/buildx" target="_blank">Buildx</a>. Disabled by default. {::nomarkdown}<ul><li>To enable with default configuration, set to <code class="highlighter-rouge">true</code>. You do not have to add any other parameters.</li>When set to <code class="highlighter-rouge">true</code>, caching is disabled.</li><li>To enable with custom configuration, set to an object with custom configuration. With custom configuration, you can configure settings for <code class="highlighter-rouge">qemu</code> and <code class="highlighter-rouge">builder</code>.<ul><li><code class="highlighter-rouge">qemu</code><ul><li><code class="highlighter-rouge">image</code>: The image to use to install the <a href="https://github.com/qemu/qemu" target="_blank">QEMU</a> static binaries. If not specified, uses the <code class="highlighter-rouge">tonistiigi/binfmt</code> Docker image, and installs the binaries from the <code class="highlighter-rouge">tonistiigi/binfmt:latest</code> Docker image. {:/} <br>To use additional trusted QEMU images, see [Defining trusted QEMU images](#defining-trusted-qemu-images).{::nomarkdown}</li><li><code class="highlighter-rouge">platforms</code>: The binaries of platform emulators to install with the Docker image defined for <code class="highlighter-rouge">image</code>. The default value is <code class="highlighter-rouge">all</code>.</li></ul><li><code class="highlighter-rouge">builder</code>: <ul><li><code class="highlighter-rouge">driver</code>: The builder driver to use. By default, uses <code class="highlighter-rouge">docker-container</code> <a href="https://docs.docker.com/build/building/drivers/docker-container" target="_blank">driver</a> to build multi-platform images and export cache using a <a href="https://github.com/moby/buildkitBuildKit" target="_blank">BuildKit</a> container.<li><code class="highlighter-rouge">driver_opts</code>: Additional driver-specific configuration options to customize the driver. For example, <code class="highlighter-rouge">image=moby/buildkit:master</code>.</li></ul></li></ul>{:/} | Optional |
119120

120121

@@ -651,21 +652,19 @@ steps:
651652
buildkit: true
652653
```
653654

654-
<!---- `Buildkit` is also automatically enabled if you use any of its features such as the `progress` property: -->
655+
`Buildkit` is also automatically enabled if you use any of its features such as the `progress` property:
655656

656657
`codefresh.yml`
657658

658659
```yaml
659-
version: '1.0'
660660
steps:
661661
BuildMyImage:
662662
title: Building My Docker image
663-
image_name: my-app-image
663+
image_name: my-app-image
664+
type: build
665+
progress: tty
664666
```
665667

666-
<!--- commenting out as not supported currently. When supported add this line to the code snippet above and remove comments: type: build
667-
progress: ttyPossible values for `progress` are `tty` and `plain`. -->
668-
669668
For secrets, you can either mention them in a single line:
670669

671670
`codefresh.yml`
@@ -761,7 +760,7 @@ steps:
761760

762761
{% endraw %}
763762

764-
You can combine all options (`ssh`, <!--- `progress`,--> `secrets`) in a single build step if desired.
763+
You can combine all options (`ssh`, `progress`, `secrets`) in a single build step if desired.
765764

766765
## Defining trusted QEMU images
767766
The `build` step supports other QEMU images in addition to the default image.

0 commit comments

Comments
 (0)