docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21150 from dvdksn/bake-guide-fixups 

build: bake guide grammatical improvements
This commit is contained in:
David Karlsson 2024-10-18 11:00:48 +02:00 committed by GitHub
parent 033acdfab1 37e6a11e58
commit 9ef98ae590
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
content/guides/bake/index.md
View File

@ -32,16 +32,16 @@ This guide assumes that you're familiar with:
## Prerequisites ## Prerequisites
- A recent version of Docker is installed on your machine. - You have a recent version of Docker installed on your machine.
- Git is installed for cloning repositories. - You have Git installed for cloning repositories.
- You're using the [containerd](/manuals/desktop/containerd.md) image store. - You're using the [containerd](/manuals/desktop/containerd.md) image store.
## Introduction ## Introduction
This guide uses an example project to demonstrate how Docker Buildx Bake can This guide uses an example project to demonstrate how Docker Buildx Bake can
streamline your build and test workflows. This repository includes both a streamline your build and test workflows. The repository includes both a
Dockerfile and `docker-bake.hcl`, giving you a ready-to-use setup to try out Dockerfile and a `docker-bake.hcl` file, giving you a ready-to-use setup to try
Bake commands. out Bake commands.
Start by cloning the example repository: Start by cloning the example repository:
@ -114,7 +114,7 @@ $ docker buildx build \
## Testing and linting ## Testing and linting
Bake isn't just for defining build configurations, and running builds. You can Bake isn't just for defining build configurations and running builds. You can
also use Bake to run your tests, effectively using BuildKit as a task runner. also use Bake to run your tests, effectively using BuildKit as a task runner.
Running your tests in containers is great for ensuring reproducible results. Running your tests in containers is great for ensuring reproducible results.
This section shows how to add two types of tests: This section shows how to add two types of tests:
@ -133,7 +133,7 @@ target "test" {
``` ```
> [!TIP] > [!TIP]
> Using the `type=cacheonly` ensures that the build output is effectively > Using `type=cacheonly` ensures that the build output is effectively
> discarded; the layers are saved to BuildKit's cache, but Buildx will not > discarded; the layers are saved to BuildKit's cache, but Buildx will not
> attempt to load the result to the Docker Engine's image store. > attempt to load the result to the Docker Engine's image store.
> >
@ -145,7 +145,7 @@ you'll receive an error indicating that the `test` stage does not exist in the
Dockerfile. Dockerfile.
```console ```console
$ docker buildx bake bake test $ docker buildx bake test
[+] Building 1.2s (6/6) FINISHED [+] Building 1.2s (6/6) FINISHED
=> [internal] load local bake definitions => [internal] load local bake definitions
... ...
@ -252,13 +252,12 @@ combinations to build:
The `matrix` attribute defines the variants to build ("release" and "debug"). The `matrix` attribute defines the variants to build ("release" and "debug").
The `name` attribute defines how the matrix gets expanded into multiple The `name` attribute defines how the matrix gets expanded into multiple
distinct build targets. In this case, it's relatively simple. The matrix distinct build targets. In this case, the matrix attribute expands the build
attribute expands the build into two workflows: `image-release` and into two workflows: `image-release` and `image-debug`, each using different
`image-debug`, each using different configuration parameters. configuration parameters.
Next, when building the development variant, we'll pass in a `BUILD_TAGS` Next, define a build argument named `BUILD_TAGS` which takes the value of the
argument with the value of the matrix variable, which we'll later consume in matrix variable.
the Dockerfile.
```diff {title="docker-bake.hcl"} ```diff {title="docker-bake.hcl"}
target = "image" target = "image"
@ -365,7 +364,7 @@ bakeme:latest 20065d2c4d22 44.4MB 25.9MB
Exporting build artifacts like binaries can be useful for deploying to Exporting build artifacts like binaries can be useful for deploying to
environments without Docker or Kubernetes. For example, if your programs are environments without Docker or Kubernetes. For example, if your programs are
meant to be run on user's local machine. meant to be run on a user's local machine.
> [!TIP] > [!TIP]
> The techniques discussed in this section can be applied not only to build > The techniques discussed in this section can be applied not only to build
@ -502,7 +501,7 @@ multi-platform builds, testing, and artifact export. By integrating Buildx Bake
into your projects, you can simplify your Docker builds, make your build into your projects, you can simplify your Docker builds, make your build
configuration portable, and wrangle complex configurations more easily. configuration portable, and wrangle complex configurations more easily.
Experiment with different configurations and extend your Bake files to match Experiment with different configurations and extend your Bake files to suit
your project's needs. You might consider integrating Bake into your CI/CD your project's needs. You might consider integrating Bake into your CI/CD
pipelines to automate builds, testing, and artifact deployment. The flexibility pipelines to automate builds, testing, and artifact deployment. The flexibility
and power of Buildx Bake can significantly improve your development and and power of Buildx Bake can significantly improve your development and