From d7b28fb4d340528926e17a29c4a6f0e352155055 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Mon, 17 May 2021 22:53:56 -0700 Subject: [PATCH] docs: update bake notes Signed-off-by: Tonis Tiigi --- README.md | 4 +++- docs/reference/buildx_bake.md | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5249d3ca..dcbbc165 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Key features: - Multiple builder instance support - Multi-node builds for cross-platform images - Compose build support -- WIP: High-level build constructs (`bake`) +- High-level build constructs (`bake`) - In-container driver support (both Docker and Kubernetes) # Table of Contents @@ -159,6 +159,8 @@ Currently, the bake command supports building images from compose files, similar There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users. +[`buildx bake` Reference Docs](docs/reference/buildx_bake.md) + # Setting buildx as default builder in Docker 19.03+ Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder. diff --git a/docs/reference/buildx_bake.md b/docs/reference/buildx_bake.md index 55821153..f23fe839 100644 --- a/docs/reference/buildx_bake.md +++ b/docs/reference/buildx_bake.md @@ -33,6 +33,10 @@ Build from a file Bake is a high-level build command. Each specified target will run in parallel as part of the build. +Read [High-level build options](https://github.com/docker/buildx#high-level-build-options) for introduction. + +Please note that `buildx bake` command may receive backwards incompatible features in the future if needed. We are looking for feedback on improving the command and extending the functionality further. + ## Examples ### Specify a build definition file (-f, --file)