docs: using bake with remote and local metadata definition

Signed-off-by: CrazyMax <[email protected]>
docker · Mar 25, 2024 · 22d80c0 · 22d80c0
1 parent 38b3677
commit 22d80c0
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -522,3 +522,30 @@ jobs:
       -
         name: Print envs
         run: env|sort
+
+  bake-cwd:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          version: latest
+      -
+        name: Docker meta
+        id: docker_meta
+        uses: ./
+      -
+        name: Build
+        uses: docker/bake-action@v4
+        with:
+          source: "{{defaultContext}}"
+          files: |
+            ./test/docker-bake.hcl
+            cwd://${{ steps.docker_meta.outputs.bake-file-tags }}
+            cwd://${{ steps.docker_meta.outputs.bake-file-labels }}
+          targets: |
+            release
diff --git a/README.md b/README.md
@@ -223,7 +223,7 @@ jobs:
             type=sha
       -
         name: Build
-        uses: docker/bake-action@v3
+        uses: docker/bake-action@v4
         with:
           files: |
             ./docker-bake.hcl
@@ -270,7 +270,7 @@ similar to the previous one:
 ```yaml
       -
         name: Build
-        uses: docker/bake-action@v3
+        uses: docker/bake-action@v4
         with:
           files: |
             ./docker-bake.hcl
@@ -279,6 +279,23 @@ similar to the previous one:
           targets: build
 ```
 
+If you're building a [remote Bake definition](https://docs.docker.com/build/bake/remote-definition/)
+using a [Git context](https://github.com/docker/bake-action?tab=readme-ov-file#git-context),
+you must specify the location of the metadata-only bake file using a `cwd://`
+prefix:
+
+```yaml
+      -
+        name: Build
+        uses: docker/bake-action@v4
+        with:
+          source: "${{ github.server_url }}/${{ github.repository }}.git#${{ github.ref }}"
+          files: |
+            ./docker-bake.hcl
+            cwd://${{ steps.meta.outputs.bake-file }}
+          targets: build
+```
+
 ## Customizing
 
 ### inputs
@@ -948,7 +965,7 @@ The same can be done with the [`bake-action`](https://github.com/docker/bake-act
           images: name/app
       -
         name: Build
-        uses: docker/bake-action@v3
+        uses: docker/bake-action@v4
         with:
           files: |
             ./docker-bake.hcl