Merge pull request #267 from docker/dependabot/npm_and_yarn/actions/core-1.10.1

build(deps): bump @actions/core from 1.10.0 to 1.10.1

.eslintignore

@@ -0,0 +1,3 @@
+/dist/**
+/coverage/**
+/node_modules/**

.eslintrc.json

@@ -1,11 +1,12 @@
 {
   "env": {
     "node": true,
-    "es2021": true,
-    "jest/globals": true
+    "es6": true,
+    "jest": true
   },
   "extends": [
     "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:jest/recommended",
     "plugin:prettier/recommended"

.github/CODEOWNERS

@@ -1 +0,0 @@
-*	@crazy-max

.github/dependabot.yml

@@ -11,6 +11,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    versioning-strategy: "increase"
     allow:
       - dependency-type: "production"
     labels:

.github/workflows/ci.yml

@@ -1,8 +1,12 @@
 name: ci
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   schedule:
-    - cron: '0 10 * * *' # everyday at 10am
+    - cron: '0 10 * * *'
   push:
     branches:
       - 'master'
@@ -10,9 +14,6 @@ on:
     tags:
       - 'v*'
   pull_request:
-    branches:
-      - 'master'
-      - 'releases/v*'
 
 jobs:
   main:
@@ -21,25 +22,34 @@ jobs:
       fail-fast: false
       matrix:
         buildx-version:
-          - latest
-          - v0.4.1
           - ""
+          - "latest"
+          - "v0.4.1"
+          - "lab:latest"
+          - "lab:v0.11.2-desktop.2"
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
+        id: buildx
         uses: ./
         with:
           version: ${{ matrix.buildx-version }}
+      -
+        name: Nodes output
+        run: |
+          cat << EOF
+          ${{ steps.buildx.outputs.nodes }}
+          EOF
 
   multi:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx 1
         uses: ./
@@ -52,11 +62,11 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Stop docker
         run: |
-          sudo systemctl stop docker
+          sudo systemctl stop docker docker.socket
       -
         name: Set up Docker Buildx
         id: buildx
@@ -73,14 +83,14 @@ jobs:
       -
         name: Dump context
         if: always()
-        uses: crazy-max/ghaction-dump-context@v1
+        uses: crazy-max/ghaction-dump-context@v2
 
   debug:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Create Dockerfile
         run: |
@@ -90,7 +100,7 @@ jobs:
           EOL
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       -
         name: Set up Docker Buildx
         uses: ./
@@ -98,7 +108,7 @@ jobs:
           buildkitd-flags: --debug
       -
         name: Build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           context: .
           platforms: linux/amd64,linux/arm64,linux/ppc64le
@@ -108,7 +118,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
@@ -130,7 +140,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
@@ -153,7 +163,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
@@ -166,7 +176,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
@@ -199,7 +209,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Create context
         run: |
@@ -221,7 +231,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Create buildkitd conf
         run: |
@@ -244,7 +254,7 @@ jobs:
           config: /tmp/buildkitd.toml
       -
         name: Build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           context: .
 
@@ -253,7 +263,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Create Dockerfile
         run: |
@@ -271,7 +281,7 @@ jobs:
               mirrors = ["mirror.gcr.io"]
       -
         name: Build
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           context: .
 
@@ -281,8 +291,7 @@ jobs:
       fail-fast: false
       matrix:
         buildx-version:
-          - latest
-          - v0.4.1
+          - v0.9.1
           - ""
         qemu-platforms:
           - all
@@ -290,17 +299,21 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
         with:
           platforms: ${{ matrix.qemu-platforms }}
       -
         name: Set up Docker Buildx
+        id: buildx
         uses: ./
         with:
           version: ${{ matrix.buildx-version }}
+      -
+        name: List builder platforms
+        run: echo ${{ steps.buildx.outputs.platforms }}
 
   build-ref:
     runs-on: ubuntu-latest
@@ -315,7 +328,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
@@ -338,11 +351,15 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Uninstall docker cli
         run: |
-          sudo apt-get purge -y moby-cli moby-buildx
+          if dpkg -s "docker-ce" >/dev/null 2>&1; then
+            sudo dpkg -r --force-depends docker-ce-cli docker-buildx-plugin
+          else
+            sudo apt-get purge -y moby-cli moby-buildx
+          fi
       -
         name: Set up Docker Buildx
         uses: ./
@@ -362,11 +379,15 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Uninstall docker cli
         run: |
-          sudo apt-get purge -y moby-cli moby-buildx
+          if dpkg -s "docker-ce" >/dev/null 2>&1; then
+            sudo dpkg -r --force-depends docker-ce-cli docker-buildx-plugin
+          else
+            sudo apt-get purge -y moby-cli moby-buildx
+          fi
       -
         name: Set up Docker Buildx
         uses: ./
@@ -389,11 +410,15 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Uninstall docker cli
         run: |
-          sudo apt-get purge -y moby-cli moby-buildx
+          if dpkg -s "docker-ce" >/dev/null 2>&1; then
+            sudo dpkg -r --force-depends docker-ce-cli docker-buildx-plugin
+          else
+            sudo apt-get purge -y moby-cli moby-buildx
+          fi
       -
         name: Set up Docker Buildx
         id: buildx
@@ -409,3 +434,132 @@ jobs:
             echo "::error::Should have failed"
             exit 1
           fi
+
+  append:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Create dummy contexts
+        run: |
+          docker context create ctxbuilder2
+          docker context create ctxbuilder3
+      -
+        name: Set up Docker Buildx
+        id: buildx
+        uses: ./
+        with:
+          append: |
+            - name: builder2
+              endpoint: ctxbuilder2
+              platforms: linux/amd64
+              driver-opts:
+                - image=moby/buildkit:master
+                - network=host
+            - endpoint: ctxbuilder3
+              platforms: linux/arm64
+      -
+        name: List builder platforms
+        run: echo ${{ steps.buildx.outputs.platforms }}
+
+  platforms:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          platforms: linux/amd64
+
+  docker-context:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Create Docker context
+        run: |
+          docker context create foo
+          docker context use foo
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          driver: docker
+
+  cleanup:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        cleanup:
+          - true
+          - false
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          cleanup: ${{ matrix.cleanup }}
+
+  k3s:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - v0.11.0
+          - v0.10.5
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Install k3s
+        uses: crazy-max/.github/.github/actions/install-k3s@605d30d5ae97f6680578ace4b56645af79343e60
+        with:
+          version: "v1.21.2-k3s1"
+      -
+        name: Set up Docker Buildx
+        id: buildx
+        uses: ./
+        with:
+          version: ${{ matrix.version }}
+          driver: kubernetes
+          platforms: linux/amd64
+          driver-opts: |
+            image=moby/buildkit:buildx-stable-1
+            qemu.install=true
+          append: |
+            - platforms: linux/arm64
+              driver-opts:
+                - image=moby/buildkit:buildx-stable-1
+                - qemu.install=true
+            - platforms: linux/s390x
+              driver-opts:
+                - image=moby/buildkit:buildx-stable-1
+                - qemu.install=true
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          RUN uname -a
+          EOL
+      -
+        name: Build
+        uses: docker/build-push-action@master
+        with:
+          context: .

.github/workflows/test.yml

@@ -1,14 +1,15 @@
 name: test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
       - 'master'
       - 'releases/v*'
   pull_request:
-    branches:
-      - 'master'
-      - 'releases/v*'
 
 jobs:
   test:
@@ -16,18 +17,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Validate
-        uses: docker/bake-action@v1
-        with:
-          targets: validate
+        uses: actions/checkout@v4
       -
         name: Set up Docker Buildx
         uses: ./
       -
         name: Test
-        uses: docker/bake-action@v1
+        uses: docker/bake-action@v3
         with:
           targets: test
       -

.github/workflows/validate.yml

@@ -0,0 +1,45 @@
+name: validate
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'releases/v*'
+  pull_request:
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      targets: ${{ steps.targets.outputs.matrix }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Targets matrix
+        id: targets
+        run: |
+          echo "matrix=$(docker buildx bake validate --print | jq -cr '.group.validate.targets')" >> $GITHUB_OUTPUT
+
+  validate:
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJson(needs.prepare.outputs.targets) }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Validate
+        uses: docker/bake-action@v3
+        with:
+          targets: ${{ matrix.target }}

README.md

@@ -1,42 +1,35 @@
 [![GitHub release](https://img.shields.io/github/release/docker/setup-buildx-action.svg?style=flat-square)](https://github.com/docker/setup-buildx-action/releases/latest)
 [![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--buildx-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-setup-buildx)
-[![CI workflow](https://img.shields.io/github/workflow/status/docker/setup-buildx-action/ci?label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=ci)
-[![Test workflow](https://img.shields.io/github/workflow/status/docker/setup-buildx-action/test?label=test&logo=github&style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=test)
+[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-buildx-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=ci)
+[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-buildx-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=test)
 [![Codecov](https://img.shields.io/codecov/c/github/docker/setup-buildx-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/setup-buildx-action)
 
 ## About
 
 GitHub Action to set up Docker [Buildx](https://github.com/docker/buildx).
 
-This action will create and boot a builder that can be used in the following steps of your workflow if you're using
-[buildx](https://github.com/docker/buildx). By default, the `docker-container` [builder driver](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#driver)
-will be used to be able to build multi-platform images and export cache thanks to the [BuildKit](https://github.com/moby/buildkit)
-container.
+This action will create and boot a builder that can be used in the following
+steps of your workflow if you're using Buildx or the [`build-push` action](https://github.com/docker/build-push-action/).
+By default, the [`docker-container` driver](https://docs.docker.com/build/building/drivers/docker-container/)
+will be used to be able to build multi-platform images and export cache using
+a [BuildKit](https://github.com/moby/buildkit) container.
 
 ![Screenshot](.github/setup-buildx-action.png)
 
 ___
 
 * [Usage](#usage)
-  * [Quick start](#quick-start)
-  * [With QEMU](#with-qemu)
-  * [Install by default](#install-by-default)
-  * [BuildKit daemon configuration](#buildkit-daemon-configuration)
-    * [Registry mirror](#registry-mirror)
-    * [Max parallelism](#max-parallelism)
-  * [Standalone mode](#standalone-mode)
+* [Configuring your builder](#configuring-your-builder)
 * [Customizing](#customizing)
   * [inputs](#inputs)
   * [outputs](#outputs)
   * [environment variables](#environment-variables)
 * [Notes](#notes)
-  * [BuildKit container logs](#buildkit-container-logs)
-* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
+  * [`nodes` output](#nodes-output)
+* [Contributing](#contributing)
 
 ## Usage
 
-### Quick start
-
 ```yaml
 name: ci
 
@@ -49,247 +42,117 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
-      -
-        name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-      -
-        name: Inspect builder
-        run: |
-          echo "Name:      ${{ steps.buildx.outputs.name }}"
-          echo "Endpoint:  ${{ steps.buildx.outputs.endpoint }}"
-          echo "Status:    ${{ steps.buildx.outputs.status }}"
-          echo "Flags:     ${{ steps.buildx.outputs.flags }}"
-          echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
-```
-
-### With QEMU
-
-If you want support for more platforms you can use our [setup-qemu](https://github.com/docker/setup-qemu-action) action:
-
-```yaml
-name: ci
-
-on:
-  push:
-
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       -
+        # Add support for more platforms with QEMU (optional)
+        # https://github.com/docker/setup-qemu-action
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       -
         name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-      -
-        name: Available platforms
-        run: echo ${{ steps.buildx.outputs.platforms }}
+        uses: docker/setup-buildx-action@v2
 ```
 
-### Install by default
+## Configuring your builder
 
-```yaml
-name: ci
-
-on:
-  push:
-
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v2
-      -
-        uses: docker/setup-buildx-action@v1
-        id: buildx
-        with:
-          install: true
-      -
-        name: Build
-        run: |
-          docker build . # will run buildx
-```
-
-### BuildKit daemon configuration
-
-You can provide a [BuildKit configuration](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md)
-to your builder if you're using the [`docker-container` driver](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#driver)
-(default) with the `config` or `config-inline` inputs:
-
-#### Registry mirror
-
-You can configure a registry mirror using an inline block directly in your
-workflow with the `config-inline` input:
-
-```yaml
-name: ci
-
-on:
-  push:
-
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-        with:
-          config-inline: |
-            [registry."docker.io"]
-              mirrors = ["mirror.gcr.io"]
-```
-
-#### Max parallelism
-
-You can limit the parallelism of the BuildKit solver which is particularly
-useful for low-powered machines.
-
-You can use the `config-inline` input like the
-previous example, or you can use a dedicated BuildKit config file from your
-repo if you want with the `config` input:
-
-```toml
-# .github/buildkitd.toml
-[worker.oci]
-  max-parallelism = 4
-```
-
-```yaml
-name: ci
-
-on:
-  push:
-
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-        with:
-          config: .github/buildkitd.toml
-```
-
-### Standalone mode
-
-If you don't have the Docker CLI installed on the GitHub Runner, buildx binary
-is invoked directly, instead of calling it as a docker plugin. This can be
-useful if you want to use the `kubernetes` driver in your self-hosted runner:
-
-```yaml
-name: ci
-
-on:
-  push:
-
-jobs:
-  buildx:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-        with:
-          driver: kubernetes
-      -
-        name: Build
-        run: |
-          buildx build .
-```
+* [Version pinning](https://docs.docker.com/build/ci/github-actions/configure-builder/#version-pinning): Pin to a specific Buildx or BuildKit version
+* [BuildKit container logs](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs): Enable BuildKit container logs for debugging purposes
+* [BuildKit Daemon configuration](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-daemon-configuration)
+  * [Registry mirror](https://docs.docker.com/build/ci/github-actions/configure-builder/#registry-mirror): Configure a registry mirror for your builds
+  * [Max parallelism](https://docs.docker.com/build/ci/github-actions/configure-builder/#max-parallelism): Configure the maximum parallelism for your builds
+* [Append additional nodes to the builder](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder): Create additional nodes for your builder
+* [Authentication for remote builders](https://docs.docker.com/build/ci/github-actions/configure-builder/#authentication-for-remote-builders)
+  * [SSH authentication](https://docs.docker.com/build/ci/github-actions/configure-builder/#ssh-authentication): Authenticate to a remote builder using SSH
+  * [TLS authentication](https://docs.docker.com/build/ci/github-actions/configure-builder/#tls-authentication): Authenticate to a remote builder using TLS
+* [Standalone mode](https://docs.docker.com/build/ci/github-actions/configure-builder/#standalone-mode): Use Buildx as a standalone binary (without the Docker CLI)
+* [Isolated builders](https://docs.docker.com/build/ci/github-actions/configure-builder/#isolated-builders): Create isolated builders for your builds
 
 ## Customizing
 
 ### inputs
 
-Following inputs can be used as `step.with` keys
+Following inputs can be used as `step.with` keys:
 
-| Name               | Type    | Description                       |
-|--------------------|---------|-----------------------------------|
-| `version`          | String  | [buildx](https://github.com/docker/buildx) version. (eg. `v0.3.0`, `latest`, `https://github.com/docker/buildx.git#master`) |
-| `driver`           | String  | Sets the [builder driver](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#driver) to be used (default `docker-container`) |
-| `driver-opts`      | CSV     | List of additional [driver-specific options](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#driver-opt) (eg. `image=moby/buildkit:master`) |
-| `buildkitd-flags`  | String  | [Flags for buildkitd](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md) daemon (since [buildx v0.3.0](https://github.com/docker/buildx/releases/tag/v0.3.0)) |
-| `install`          | Bool    | Sets up `docker build` command as an alias to `docker buildx` (default `false`) |
-| `use`              | Bool    | Switch to this builder instance (default `true`) |
-| `endpoint`         | String  | [Optional address for docker socket](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#description) or context from `docker context ls` |
-| `config`¹          | String  | [BuildKit config file](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#config) |
-| `config-inline`¹   | String  | Same as `config` but inline |
-
-> * ¹ `config` and `config-inline` are mutually exclusive
-
-> `CSV` type must be a newline-delimited string
-> ```yaml
-> driver-opts: image=moby/buildkit:master
-> ```
+> `List` type is a newline-delimited string
 > ```yaml
 > driver-opts: |
 >   image=moby/buildkit:master
 >   network=host
 > ```
 
+> `CSV` type must be a comma-delimited string
+> ```yaml
+> platforms: linux/amd64,linux/arm64
+> ```
+
+| Name              | Type     | Default            | Description                                                                                                                                                                  |
+|-------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `version`         | String   |                    | [Buildx](https://github.com/docker/buildx) version. (eg. `v0.3.0`, `latest`, `https://github.com/docker/buildx.git#master`)                                                  |
+| `driver`          | String   | `docker-container` | Sets the [builder driver](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver) to be used                                                             |
+| `driver-opts`     | List     |                    | List of additional [driver-specific options](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver-opt) (eg. `image=moby/buildkit:master`)              |
+| `buildkitd-flags` | String   |                    | [Flags for buildkitd](https://docs.docker.com/engine/reference/commandline/buildx_create/#buildkitd-flags) daemon                                                            |
+| `install`         | Bool     | `false`            | Sets up `docker build` command as an alias to `docker buildx`                                                                                                                |
+| `use`             | Bool     | `true`             | Switch to this builder instance                                                                                                                                              |
+| `endpoint`        | String   |                    | [Optional address for docker socket](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) or context from `docker context ls`                    |
+| `platforms`       | List/CSV |                    | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for current node. If not empty, values take priority over the detected ones. |
+| `config`¹         | String   |                    | [BuildKit config file](https://docs.docker.com/engine/reference/commandline/buildx_create/#config)                                                                           |
+| `config-inline`¹  | String   |                    | Same as `config` but inline                                                                                                                                                  |
+| `append`          | YAML     |                    | [Append additional nodes](docs/advanced/append-nodes.md) to the builder                                                                                                      |
+| `cleanup`         | Bool     | `true`             | Cleanup temp files and remove builder at the end of a job                                                                                                                    |
+
+> * ¹ `config` and `config-inline` are mutually exclusive
+
 ### outputs
 
 Following outputs are available
 
-| Name          | Type    | Description                           |
-|---------------|---------|---------------------------------------|
-| `name`        | String  | Builder name |
-| `driver`      | String  | Builder driver |
-| `endpoint`    | String  | Builder node endpoint |
-| `status`      | String  | Builder node status |
-| `flags`       | String  | Builder node flags (if applicable) |
-| `platforms`   | String  | Builder node platforms available (comma separated) |
+| Name        | Type   | Description                                     |
+|-------------|--------|-------------------------------------------------|
+| `name`      | String | Builder name                                    |
+| `driver`    | String | Builder driver                                  |
+| `platforms` | String | Builder node platforms (preferred or available) |
+| `nodes`     | JSON   | Builder [nodes metadata](#nodes-output)         |
 
 ### environment variables
 
 The following [official docker environment variables](https://docs.docker.com/engine/reference/commandline/cli/#environment-variables) are supported:
 
-| Name            | Type    | Default      | Description                                    |
-|-----------------|---------|-------------|-------------------------------------------------|
-| `DOCKER_CONFIG` | String  | `~/.docker` | The location of your client configuration files |
+| Name            | Type   | Default     | Description                                     |
+|-----------------|--------|-------------|-------------------------------------------------|
+| `DOCKER_CONFIG` | String | `~/.docker` | The location of your client configuration files |
 
 ## Notes
 
-### BuildKit container logs
+### `nodes` output
 
-To display BuildKit container logs (when `docker-container` driver is used) you have to [enable step debug logging](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging)
-or you can also enable debugging in the [setup-buildx action step](https://github.com/docker/setup-buildx-action):
-
-```yaml
-  -
-    name: Set up Docker Buildx
-    uses: docker/setup-buildx-action@v1
-    with:
-      buildkitd-flags: --debug
+```json
+[
+  {
+     "name": "builder-3820d274-502c-4498-ae24-d4c32b3023d90",
+     "endpoint": "unix:///var/run/docker.sock",
+     "driver-opts": [
+       "network=host",
+       "image=moby/buildkit:master"
+     ],
+    "status": "running",
+    "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+    "buildkit": "3fab389",
+    "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386"
+  }
+]
 ```
 
-Logs will be available at the end of a job:
+| Name              | Type   | Description                |
+|-------------------|--------|----------------------------|
+| `name`            | String | Node name                  |
+| `endpoint`        | String | Node endpoint              |
+| `driver-opts`     | List   | Options for the driver     |
+| `status`          | String | Node status                |
+| `buildkitd-flags` | String | Flags for buildkitd daemon |
+| `buildkit`        | String | BuildKit version           |
+| `platforms`       | String | Platforms available        |
 
-![BuildKit container logs](.github/buildkit-container-logs.png)
+## Contributing
 
-## Keep up-to-date with GitHub Dependabot
-
-Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
-has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem),
-to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
-
-```yaml
-version: 2
-updates:
-  # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-```
+Want to contribute? Awesome! You can find information about contributing to
+this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

__tests__/buildx.test.ts

@@ -1,147 +0,0 @@
-import {describe, expect, it, jest, test} from '@jest/globals';
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import * as buildx from '../src/buildx';
-import * as context from '../src/context';
-import * as semver from 'semver';
-import * as exec from '@actions/exec';
-
-const tmpNameSync = path.join('/tmp/.docker-setup-buildx-jest', '.tmpname-jest').split(path.sep).join(path.posix.sep);
-
-jest.spyOn(context, 'tmpDir').mockImplementation((): string => {
-  const tmpDir = path.join('/tmp/.docker-setup-buildx-jest').split(path.sep).join(path.posix.sep);
-  if (!fs.existsSync(tmpDir)) {
-    fs.mkdirSync(tmpDir, {recursive: true});
-  }
-  return tmpDir;
-});
-
-jest.spyOn(context, 'tmpNameSync').mockImplementation((): string => {
-  return tmpNameSync;
-});
-
-describe('isAvailable', () => {
-  const execSpy = jest.spyOn(exec, 'getExecOutput');
-  buildx.isAvailable();
-
-  // eslint-disable-next-line jest/no-standalone-expect
-  expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx'], {
-    silent: true,
-    ignoreReturnCode: true
-  });
-});
-
-describe('isAvailable standalone', () => {
-  const execSpy = jest.spyOn(exec, 'getExecOutput');
-  buildx.isAvailable(true);
-
-  // eslint-disable-next-line jest/no-standalone-expect
-  expect(execSpy).toHaveBeenCalledWith(`buildx`, [], {
-    silent: true,
-    ignoreReturnCode: true
-  });
-});
-
-describe('getVersion', () => {
-  it('valid', async () => {
-    const version = await buildx.getVersion();
-    expect(semver.valid(version)).not.toBeNull();
-  });
-});
-
-describe('parseVersion', () => {
-  test.each([
-    ['github.com/docker/buildx 0.4.1+azure bda4882a65349ca359216b135896bddc1d92461c', '0.4.1'],
-    ['github.com/docker/buildx v0.4.1 bda4882a65349ca359216b135896bddc1d92461c', '0.4.1'],
-    ['github.com/docker/buildx v0.4.2 fb7b670b764764dc4716df3eba07ffdae4cc47b2', '0.4.2'],
-    ['github.com/docker/buildx f117971 f11797113e5a9b86bd976329c5dbb8a8bfdfadfa', 'f117971']
-  ])('given %p', async (stdout, expected) => {
-    expect(buildx.parseVersion(stdout)).toEqual(expected);
-  });
-});
-
-describe('satisfies', () => {
-  test.each([
-    ['0.4.1', '>=0.3.2', true],
-    ['bda4882a65349ca359216b135896bddc1d92461c', '>0.1.0', false],
-    ['f117971', '>0.6.0', true]
-  ])('given %p', async (version, range, expected) => {
-    expect(buildx.satisfies(version, range)).toBe(expected);
-  });
-});
-
-describe('inspect', () => {
-  it('valid', async () => {
-    const builder = await buildx.inspect('');
-    expect(builder).not.toBeUndefined();
-    expect(builder.name).not.toEqual('');
-    expect(builder.driver).not.toEqual('');
-    expect(builder.node_platforms).not.toEqual('');
-  }, 100000);
-});
-
-describe('build', () => {
-  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'setup-buildx-'));
-
-  // eslint-disable-next-line jest/no-disabled-tests
-  it.skip('builds refs/pull/648/head', async () => {
-    const buildxBin = await buildx.build('https://github.com/docker/buildx.git#refs/pull/648/head', tmpDir, false);
-    expect(fs.existsSync(buildxBin)).toBe(true);
-  }, 100000);
-
-  // eslint-disable-next-line jest/no-disabled-tests
-  it.skip('builds 67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', async () => {
-    const buildxBin = await buildx.build('https://github.com/docker/buildx.git#67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', tmpDir, false);
-    expect(fs.existsSync(buildxBin)).toBe(true);
-  }, 100000);
-});
-
-describe('install', () => {
-  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'setup-buildx-'));
-  test.each([
-    ['v0.4.1', false],
-    ['latest', false],
-    ['v0.4.1', true],
-    ['latest', true]
-  ])(
-    'acquires %p of buildx (standalone: %p)',
-    async (version, standalone) => {
-      const buildxBin = await buildx.install(version, tmpDir, standalone);
-      expect(fs.existsSync(buildxBin)).toBe(true);
-    },
-    100000
-  );
-});
-
-describe('getConfig', () => {
-  test.each([
-    ['debug = true', false, 'debug = true', false],
-    [`notfound.toml`, true, '', true],
-    [
-      `${path.join(__dirname, 'fixtures', 'buildkitd.toml').split(path.sep).join(path.posix.sep)}`,
-      true,
-      `debug = true
-[registry."docker.io"]
-  mirrors = ["mirror.gcr.io"]
-`,
-      false
-    ]
-  ])('given %p config', async (val, file, exValue, invalid) => {
-    try {
-      let config: string;
-      if (file) {
-        config = await buildx.getConfigFile(val);
-      } else {
-        config = await buildx.getConfigInline(val);
-      }
-      expect(true).toBe(!invalid);
-      expect(config).toEqual(`${tmpNameSync}`);
-      const configValue = fs.readFileSync(tmpNameSync, 'utf-8');
-      expect(configValue).toEqual(exValue);
-    } catch (err) {
-      // eslint-disable-next-line jest/no-conditional-expect
-      expect(true).toBe(invalid);
-    }
-  });
-});

__tests__/context.test.ts

@@ -1,112 +1,241 @@
-import {beforeEach, describe, expect, it, jest} from '@jest/globals';
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
+import {beforeEach, describe, expect, jest, test} from '@jest/globals';
+import * as uuid from 'uuid';
+import {Buildx} from '@docker/actions-toolkit/lib/buildx/buildx';
+import {Docker} from '@docker/actions-toolkit/lib/docker/docker';
+import {Toolkit} from '@docker/actions-toolkit/lib/toolkit';
+import {Node} from '@docker/actions-toolkit/lib/types/builder';
+
 import * as context from '../src/context';
 
-jest.spyOn(context, 'tmpDir').mockImplementation((): string => {
-  const tmpDir = path.join('/tmp/.docker-setup-buildx-jest').split(path.sep).join(path.posix.sep);
-  if (!fs.existsSync(tmpDir)) {
-    fs.mkdirSync(tmpDir, {recursive: true});
-  }
-  return tmpDir;
+jest.mock('uuid');
+jest.spyOn(uuid, 'v4').mockReturnValue('9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d');
+
+jest.spyOn(Docker, 'context').mockImplementation((): Promise<string> => {
+  return Promise.resolve('default');
 });
 
-jest.spyOn(context, 'tmpNameSync').mockImplementation((): string => {
-  return path.join('/tmp/.docker-setup-buildx-jest', '.tmpname-jest').split(path.sep).join(path.posix.sep);
-});
-
-describe('getInputList', () => {
-  it('handles single line correctly', async () => {
-    await setInput('foo', 'bar');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar']);
-  });
-
-  it('handles multiple lines correctly', async () => {
-    setInput('foo', 'bar\nbaz');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz']);
-  });
-
-  it('remove empty lines correctly', async () => {
-    setInput('foo', 'bar\n\nbaz');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz']);
-  });
-
-  it('handles comma correctly', async () => {
-    setInput('foo', 'bar,baz');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz']);
-  });
-
-  it('remove empty result correctly', async () => {
-    setInput('foo', 'bar,baz,');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz']);
-  });
-
-  it('handles different new lines correctly', async () => {
-    setInput('foo', 'bar\r\nbaz');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz']);
-  });
-
-  it('handles different new lines and comma correctly', async () => {
-    setInput('foo', 'bar\r\nbaz,bat');
-    const res = await context.getInputList('foo');
-    expect(res).toEqual(['bar', 'baz', 'bat']);
-  });
-
-  it('handles multiple lines and ignoring comma correctly', async () => {
-    setInput('driver-opts', 'image=moby/buildkit:master\nnetwork=host');
-    const res = await context.getInputList('driver-opts', true);
-    expect(res).toEqual(['image=moby/buildkit:master', 'network=host']);
-  });
-
-  it('handles different new lines and ignoring comma correctly', async () => {
-    setInput('driver-opts', 'image=moby/buildkit:master\r\nnetwork=host');
-    const res = await context.getInputList('driver-opts', true);
-    expect(res).toEqual(['image=moby/buildkit:master', 'network=host']);
-  });
-});
-
-describe('asyncForEach', () => {
-  it('executes async tasks sequentially', async () => {
-    const testValues = [1, 2, 3, 4, 5];
-    const results: number[] = [];
-
-    await context.asyncForEach(testValues, async value => {
-      results.push(value);
-    });
-
-    expect(results).toEqual(testValues);
-  });
-});
-
-describe('setOutput', () => {
+describe('getCreateArgs', () => {
   beforeEach(() => {
-    process.stdout.write = jest.fn() as typeof process.stdout.write;
+    process.env = Object.keys(process.env).reduce((object, key) => {
+      if (!key.startsWith('INPUT_')) {
+        object[key] = process.env[key];
+      }
+      return object;
+    }, {});
   });
 
-  // eslint-disable-next-line jest/expect-expect
-  it('setOutput produces the correct command', () => {
-    context.setOutput('some output', 'some value');
-    assertWriteCalls([`::set-output name=some output::some value${os.EOL}`]);
+  // prettier-ignore
+  test.each([
+    [
+      0,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'docker-container',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use'
+      ]
+    ],
+    [
+      1,
+      'v0.10.3',
+      new Map<string, string>([
+        ['driver', 'docker'],
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'default',
+        '--driver', 'docker',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use'
+      ]
+    ],
+    [
+      2,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['driver-opts', 'image=moby/buildkit:master\nnetwork=host'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'docker-container',
+        '--driver-opt', 'image=moby/buildkit:master',
+        '--driver-opt', 'network=host',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host'
+      ]
+    ],
+    [
+      3,
+      'v0.10.3',
+      new Map<string, string>([
+        ['driver', 'remote'],
+        ['endpoint', 'tls://foo:1234'],
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'remote',
+        '--use',
+        'tls://foo:1234'
+      ]
+    ],
+    [
+      4,
+      'v0.10.3',
+      new Map<string, string>([
+        ['driver', 'remote'],
+        ['platforms', 'linux/arm64,linux/arm/v7'],
+        ['endpoint', 'tls://foo:1234'],
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'remote',
+        '--platform', 'linux/arm64,linux/arm/v7',
+        '--use',
+        'tls://foo:1234'
+      ]
+    ],
+    [
+      5,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['driver-opts', `"env.no_proxy=localhost,127.0.0.1,.mydomain"`],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'docker-container',
+        '--driver-opt', '"env.no_proxy=localhost,127.0.0.1,.mydomain"',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host'
+      ]
+    ],
+    [
+      6,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['platforms', 'linux/amd64\n"linux/arm64,linux/arm/v7"'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'docker-container',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--platform', 'linux/amd64,linux/arm64,linux/arm/v7'
+      ]
+    ],
+    [
+      7,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['driver', 'unknown'],
+        ['cleanup', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'unknown',
+      ]
+    ]
+  ])(
+    '[%d] given buildx %s and %p as inputs, returns %p',
+    async (num: number, buildxVersion: string, inputs: Map<string, string>, expected: Array<string>) => {
+      inputs.forEach((value: string, name: string) => {
+        setInput(name, value);
+      });
+      const toolkit = new Toolkit();
+      jest.spyOn(Buildx.prototype, 'version').mockImplementation(async (): Promise<string> => {
+        return buildxVersion;
+      });
+      const inp = await context.getInputs();
+      const res = await context.getCreateArgs(inp, toolkit);
+      expect(res).toEqual(expected);
+    }
+  );
+});
+
+describe('getAppendArgs', () => {
+  beforeEach(() => {
+    process.env = Object.keys(process.env).reduce((object, key) => {
+      if (!key.startsWith('INPUT_')) {
+        object[key] = process.env[key];
+      }
+      return object;
+    }, {});
   });
 
-  // eslint-disable-next-line jest/expect-expect
-  it('setOutput handles bools', () => {
-    context.setOutput('some output', false);
-    assertWriteCalls([`::set-output name=some output::false${os.EOL}`]);
-  });
-
-  // eslint-disable-next-line jest/expect-expect
-  it('setOutput handles numbers', () => {
-    context.setOutput('some output', 1.01);
-    assertWriteCalls([`::set-output name=some output::1.01${os.EOL}`]);
-  });
+  // prettier-ignore
+  test.each([
+    [
+      0,
+      'v0.10.3',
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'true'],
+        ['cleanup', 'true'],
+      ]),
+      {
+        "name": "aws_graviton2",
+        "endpoint": "ssh://me@graviton2",
+        "driver-opts": [
+          "image=moby/buildkit:latest"
+        ],
+        "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+        "platforms": "linux/arm64"
+      },
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--append',
+        '--node', 'aws_graviton2',
+        '--driver-opt', 'image=moby/buildkit:latest',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--platform', 'linux/arm64',
+        'ssh://me@graviton2'
+      ]
+    ]
+  ])(
+    '[%d] given buildx %s and %p as inputs, returns %p',
+    async (num: number, buildxVersion: string, inputs: Map<string, string>, node: Node, expected: Array<string>) => {
+      inputs.forEach((value: string, name: string) => {
+        setInput(name, value);
+      });
+      const toolkit = new Toolkit();
+      jest.spyOn(Buildx.prototype, 'version').mockImplementation(async (): Promise<string> => {
+        return buildxVersion;
+      });
+      const inp = await context.getInputs();
+      const res = await context.getAppendArgs(inp, node, toolkit);
+      expect(res).toEqual(expected);
+    }
+  );
 });
 
 // See: https://github.com/actions/toolkit/blob/master/packages/core/src/core.ts#L67
@@ -117,11 +246,3 @@ function getInputName(name: string): string {
 function setInput(name: string, value: string): void {
   process.env[getInputName(name)] = value;
 }
-
-// Assert that process.stdout.write calls called only with the given arguments.
-function assertWriteCalls(calls: string[]): void {
-  expect(process.stdout.write).toHaveBeenCalledTimes(calls.length);
-  for (let i = 0; i < calls.length; i++) {
-    expect(process.stdout.write).toHaveBeenNthCalledWith(i + 1, calls[i]);
-  }
-}

__tests__/docker.test.ts

@@ -1,16 +0,0 @@
-import {describe, expect, it, jest} from '@jest/globals';
-import * as docker from '../src/docker';
-import * as exec from '@actions/exec';
-
-describe('isAvailable', () => {
-  it('cli', () => {
-    const execSpy = jest.spyOn(exec, 'getExecOutput');
-    docker.isAvailable();
-
-    // eslint-disable-next-line jest/no-standalone-expect
-    expect(execSpy).toHaveBeenCalledWith(`docker`, undefined, {
-      silent: true,
-      ignoreReturnCode: true
-    });
-  });
-});

__tests__/fixtures/buildkitd.toml

@@ -1,3 +0,0 @@
-debug = true
-[registry."docker.io"]
-  mirrors = ["mirror.gcr.io"]

__tests__/git.test.ts

@@ -1,9 +0,0 @@
-import {describe, expect, it} from '@jest/globals';
-import * as git from '../src/git';
-
-describe('git', () => {
-  it('returns git remote ref', async () => {
-    const ref: string = await git.getRemoteSha('https://github.com/docker/buildx.git', 'refs/pull/648/head');
-    expect(ref).toEqual('f11797113e5a9b86bd976329c5dbb8a8bfdfadfa');
-  });
-});

__tests__/github.test.ts

@@ -1,16 +0,0 @@
-import {describe, expect, it} from '@jest/globals';
-import * as github from '../src/github';
-
-describe('github', () => {
-  it('returns latest buildx GitHub release', async () => {
-    const release = await github.getRelease('latest');
-    expect(release).not.toBeNull();
-    expect(release?.tag_name).not.toEqual('');
-  });
-
-  it('returns v0.2.2 buildx GitHub release', async () => {
-    const release = await github.getRelease('v0.2.2');
-    expect(release).not.toBeNull();
-    expect(release?.tag_name).toEqual('v0.2.2');
-  });
-});

__tests__/util.test.ts

@@ -1,12 +0,0 @@
-import {describe, expect, test} from '@jest/globals';
-import * as util from '../src/util';
-
-describe('isValidUrl', () => {
-  test.each([
-    ['https://github.com/docker/buildx.git', true],
-    ['https://github.com/docker/buildx.git#refs/pull/648/head', true],
-    ['v0.4.1', false]
-  ])('given %p', async (url, expected) => {
-    expect(util.isValidUrl(url)).toEqual(expected);
-  });
-});

action.yml

@@ -22,7 +22,7 @@ inputs:
     default: '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host'
     required: false
   install:
-    description: 'Sets up docker build command as an alias to docker buildx'
+    description: 'Sets up docker build command as an alias to docker buildx build'
     default: 'false'
     required: false
   use:
@@ -32,28 +32,40 @@ inputs:
   endpoint:
     description: 'Optional address for docker socket or context from `docker context ls`'
     required: false
+  platforms:
+    description: 'Fixed platforms for current node. If not empty, values take priority over the detected ones'
+    required: false
   config:
     description: 'BuildKit config file'
     required: false
   config-inline:
     description: 'Inline BuildKit config'
     required: false
+  append:
+    description: 'Append additional nodes to the builder'
+    required: false
+  cleanup:
+    description: 'Cleanup temp files and remove builder at the end of a job'
+    default: 'true'
+    required: false
 
 outputs:
   name:
     description: 'Builder name'
   driver:
     description: 'Builder driver'
-  endpoint:
-    description: 'Builder node endpoint'
-  status:
-    description: 'Builder node status'
-  flags:
-    description: 'Builder node flags (if applicable)'
   platforms:
-    description: 'Builder node platforms available (comma separated)'
+    description: 'Builder node platforms (preferred or available)'
+  nodes:
+    description: 'Builder nodes metadata'
+  endpoint:
+    description: 'Builder node endpoint (deprecated, use nodes output instead)'
+  status:
+    description: 'Builder node status (deprecated, use nodes output instead)'
+  flags:
+    description: 'Builder node flags (deprecated, use nodes output instead)'
 
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'
   post: 'dist/index.js'

dev.Dockerfile

@@ -1,8 +1,6 @@
 # syntax=docker/dockerfile:1
 
-ARG NODE_VERSION=16
-ARG DOCKER_VERSION=20.10.13
-ARG BUILDX_VERSION=0.8.1
+ARG NODE_VERSION=20
 
 FROM node:${NODE_VERSION}-alpine AS base
 RUN apk add --no-cache cpio findutils git
@@ -62,17 +60,12 @@ RUN --mount=type=bind,target=.,rw \
   --mount=type=cache,target=/src/node_modules \
   yarn run lint
 
-FROM docker:${DOCKER_VERSION} as docker
-FROM docker/buildx-bin:${BUILDX_VERSION} as buildx
-
 FROM deps AS test
 ENV RUNNER_TEMP=/tmp/github_runner
 ENV RUNNER_TOOL_CACHE=/tmp/github_tool_cache
 RUN --mount=type=bind,target=.,rw \
   --mount=type=cache,target=/src/node_modules \
-  --mount=type=bind,from=docker,source=/usr/local/bin/docker,target=/usr/bin/docker \
-  --mount=type=bind,from=buildx,source=/buildx,target=/usr/libexec/docker/cli-plugins/docker-buildx \
-  yarn run test --coverageDirectory=/tmp/coverage
+  yarn run test --coverage --coverageDirectory=/tmp/coverage
 
 FROM scratch AS test-coverage
 COPY --from=test /tmp/coverage /

docs/advanced/append-nodes.md

@@ -0,0 +1,3 @@
+# Append additional nodes to the builder
+
+This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder)

docs/advanced/auth.md

@@ -0,0 +1,3 @@
+# Authentication support
+
+This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#authentication-for-remote-builders)

docs/advanced/buildkit-config.md

@@ -0,0 +1,3 @@
+# BuildKit daemon configuration
+
+This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-daemon-configuration)

docs/advanced/standalone.md

@@ -0,0 +1,3 @@
+# Standalone mode
+
+This page has moved to [Docker Docs website](https://docs.docker.com/build/ci/github-actions/configure-builder/#standalone-mode)

jest.config.ts

@@ -1,10 +1,29 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-buildx-action-')).split(path.sep).join(path.posix.sep);
+
+process.env = Object.assign({}, process.env, {
+  TEMP: tmpDir,
+  GITHUB_REPOSITORY: 'docker/setup-buildx-action',
+  RUNNER_TEMP: path.join(tmpDir, 'runner-temp').split(path.sep).join(path.posix.sep),
+  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache').split(path.sep).join(path.posix.sep)
+}) as {
+  [key: string]: string;
+};
+
 module.exports = {
   clearMocks: true,
   moduleFileExtensions: ['js', 'ts'],
-  setupFiles: ["dotenv/config"],
   testMatch: ['**/*.test.ts'],
   transform: {
     '^.+\\.ts$': 'ts-jest'
   },
+  moduleNameMapper: {
+    '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
+  },
+  collectCoverageFrom: ['src/**/{!(main.ts),}.ts'],
+  coveragePathIgnorePatterns: ['lib/', 'node_modules/', '__tests__/'],
   verbose: true
-}
+};

package.json

@@ -4,9 +4,13 @@
   "main": "lib/main.js",
   "scripts": {
     "build": "ncc build src/main.ts --source-map --minify --license licenses.txt",
-    "lint": "eslint src/**/*.ts __tests__/**/*.ts",
-    "format": "eslint --fix src/**/*.ts __tests__/**/*.ts",
-    "test": "jest --coverage",
+    "lint": "yarn run prettier && yarn run eslint",
+    "format": "yarn run prettier:fix && yarn run eslint:fix",
+    "eslint": "eslint --max-warnings=0 .",
+    "eslint:fix": "eslint --fix .",
+    "prettier": "prettier --check \"./**/*.ts\"",
+    "prettier:fix": "prettier --write \"./**/*.ts\"",
+    "test": "jest",
     "all": "yarn run build && yarn run format && yarn test"
   },
   "repository": {
@@ -18,39 +22,28 @@
     "docker",
     "buildx"
   ],
-  "author": "Docker",
-  "contributors": [
-    {
-      "name": "CrazyMax",
-      "url": "https://crazymax.dev"
-    }
-  ],
+  "author": "Docker Inc.",
   "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.6.0",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1",
-    "@actions/http-client": "^1.0.11",
-    "@actions/tool-cache": "^1.7.2",
-    "semver": "^7.3.7",
-    "tmp": "^0.2.1",
-    "uuid": "^8.3.2"
+    "@docker/actions-toolkit": "^0.12.0",
+    "js-yaml": "^4.1.0",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/node": "^16.11.26",
-    "@types/semver": "^7.3.9",
-    "@types/tmp": "^0.2.3",
-    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "@typescript-eslint/parser": "^5.14.0",
-    "@vercel/ncc": "^0.33.3",
-    "dotenv": "^16.0.0",
-    "eslint": "^8.11.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.5",
-    "prettier": "^2.3.1",
-    "ts-jest": "^27.1.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.4.4"
+    "@types/node": "^20.5.9",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "@vercel/ncc": "^0.38.0",
+    "eslint": "^8.48.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.4",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   }
 }

src/buildx.ts

@@ -1,337 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as semver from 'semver';
-import * as util from 'util';
-import * as context from './context';
-import * as git from './git';
-import * as github from './github';
-import * as core from '@actions/core';
-import * as exec from '@actions/exec';
-import * as tc from '@actions/tool-cache';
-
-export type Builder = {
-  name?: string;
-  driver?: string;
-  node_name?: string;
-  node_endpoint?: string;
-  node_status?: string;
-  node_flags?: string;
-  node_platforms?: string;
-};
-
-export async function getConfigInline(s: string): Promise<string> {
-  return getConfig(s, false);
-}
-
-export async function getConfigFile(s: string): Promise<string> {
-  return getConfig(s, true);
-}
-
-export async function getConfig(s: string, file: boolean): Promise<string> {
-  if (file) {
-    if (!fs.existsSync(s)) {
-      throw new Error(`config file ${s} not found`);
-    }
-    s = fs.readFileSync(s, {encoding: 'utf-8'});
-  }
-  const configFile = context.tmpNameSync({
-    tmpdir: context.tmpDir()
-  });
-  fs.writeFileSync(configFile, s);
-  return configFile;
-}
-
-export async function isAvailable(standalone?: boolean): Promise<boolean> {
-  const cmd = getCommand([], standalone);
-  return await exec
-    .getExecOutput(cmd.commandLine, cmd.args, {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        return false;
-      }
-      return res.exitCode == 0;
-    })
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    .catch(error => {
-      return false;
-    });
-}
-
-export async function getVersion(standalone?: boolean): Promise<string> {
-  const cmd = getCommand(['version'], standalone);
-  return await exec
-    .getExecOutput(cmd.commandLine, cmd.args, {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        throw new Error(res.stderr.trim());
-      }
-      return parseVersion(res.stdout.trim());
-    });
-}
-
-export function parseVersion(stdout: string): string {
-  const matches = /\sv?([0-9a-f]{7}|[0-9.]+)/.exec(stdout);
-  if (!matches) {
-    throw new Error(`Cannot parse buildx version`);
-  }
-  return matches[1];
-}
-
-export function satisfies(version: string, range: string): boolean {
-  return semver.satisfies(version, range) || /^[0-9a-f]{7}$/.exec(version) !== null;
-}
-
-export async function inspect(name: string, standalone?: boolean): Promise<Builder> {
-  const cmd = getCommand(['inspect', name], standalone);
-  return await exec
-    .getExecOutput(cmd.commandLine, cmd.args, {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        throw new Error(res.stderr.trim());
-      }
-      const builder: Builder = {};
-      itlines: for (const line of res.stdout.trim().split(`\n`)) {
-        const [key, ...rest] = line.split(':');
-        const value = rest.map(v => v.trim()).join(':');
-        if (key.length == 0 || value.length == 0) {
-          continue;
-        }
-        switch (key) {
-          case 'Name': {
-            if (builder.name == undefined) {
-              builder.name = value;
-            } else {
-              builder.node_name = value;
-            }
-            break;
-          }
-          case 'Driver': {
-            builder.driver = value;
-            break;
-          }
-          case 'Endpoint': {
-            builder.node_endpoint = value;
-            break;
-          }
-          case 'Status': {
-            builder.node_status = value;
-            break;
-          }
-          case 'Flags': {
-            builder.node_flags = value;
-            break;
-          }
-          case 'Platforms': {
-            builder.node_platforms = value.replace(/\s/g, '');
-            break itlines;
-          }
-        }
-      }
-      return builder;
-    });
-}
-
-export async function build(inputBuildRef: string, dest: string, standalone: boolean): Promise<string> {
-  // eslint-disable-next-line prefer-const
-  let [repo, ref] = inputBuildRef.split('#');
-  if (ref.length == 0) {
-    ref = 'master';
-  }
-
-  let vspec: string;
-  if (ref.match(/^[0-9a-fA-F]{40}$/)) {
-    vspec = ref;
-  } else {
-    vspec = await git.getRemoteSha(repo, ref);
-  }
-  core.debug(`Tool version spec ${vspec}`);
-
-  let toolPath: string;
-  toolPath = tc.find('buildx', vspec);
-  if (!toolPath) {
-    const outFolder = path.join(context.tmpDir(), 'out').split(path.sep).join(path.posix.sep);
-    let buildWithStandalone = false;
-    const standaloneFound = await isAvailable(true);
-    const pluginFound = await isAvailable(false);
-    if (standalone && standaloneFound) {
-      core.debug(`Buildx standalone found, build with it`);
-      buildWithStandalone = true;
-    } else if (!standalone && pluginFound) {
-      core.debug(`Buildx plugin found, build with it`);
-      buildWithStandalone = false;
-    } else if (standaloneFound) {
-      core.debug(`Buildx plugin not found, but standalone found so trying to build with it`);
-      buildWithStandalone = true;
-    } else if (pluginFound) {
-      core.debug(`Buildx standalone not found, but plugin found so trying to build with it`);
-      buildWithStandalone = false;
-    } else {
-      throw new Error(`Neither buildx standalone or plugin have been found to build from ref`);
-    }
-    const buildCmd = getCommand(['build', '--target', 'binaries', '--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1', '--output', `type=local,dest=${outFolder}`, inputBuildRef], buildWithStandalone);
-    toolPath = await exec
-      .getExecOutput(buildCmd.commandLine, buildCmd.args, {
-        ignoreReturnCode: true
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          core.warning(res.stderr.trim());
-        }
-        return tc.cacheFile(`${outFolder}/buildx`, context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx', 'buildx', vspec);
-      });
-  }
-
-  if (standalone) {
-    return setStandalone(toolPath, dest);
-  }
-  return setPlugin(toolPath, dest);
-}
-
-export async function install(inputVersion: string, dest: string, standalone: boolean): Promise<string> {
-  const release: github.GitHubRelease | null = await github.getRelease(inputVersion);
-  if (!release) {
-    throw new Error(`Cannot find buildx ${inputVersion} release`);
-  }
-  core.debug(`Release ${release.tag_name} found`);
-  const version = release.tag_name.replace(/^v+|v+$/g, '');
-
-  let toolPath: string;
-  toolPath = tc.find('buildx', version);
-  if (!toolPath) {
-    const c = semver.clean(version) || '';
-    if (!semver.valid(c)) {
-      throw new Error(`Invalid Buildx version "${version}".`);
-    }
-    toolPath = await download(version);
-  }
-
-  if (standalone) {
-    return setStandalone(toolPath, dest);
-  }
-  return setPlugin(toolPath, dest);
-}
-
-async function setStandalone(toolPath: string, dest: string): Promise<string> {
-  core.info('Standalone mode');
-  const toolBinPath = path.join(toolPath, context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
-
-  const binDir = path.join(dest, 'bin');
-  core.debug(`Bin dir is ${binDir}`);
-  if (!fs.existsSync(binDir)) {
-    fs.mkdirSync(binDir, {recursive: true});
-  }
-
-  const filename: string = context.osPlat == 'win32' ? 'buildx.exe' : 'buildx';
-  const buildxPath: string = path.join(binDir, filename);
-  core.debug(`Bin path is ${buildxPath}`);
-  fs.copyFileSync(toolBinPath, buildxPath);
-
-  core.info('Fixing perms');
-  fs.chmodSync(buildxPath, '0755');
-
-  core.addPath(binDir);
-  core.info('Added buildx to the path');
-
-  return buildxPath;
-}
-
-async function setPlugin(toolPath: string, dockerConfigHome: string): Promise<string> {
-  core.info('Docker plugin mode');
-  const toolBinPath = path.join(toolPath, context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
-
-  const pluginsDir: string = path.join(dockerConfigHome, 'cli-plugins');
-  core.debug(`Plugins dir is ${pluginsDir}`);
-  if (!fs.existsSync(pluginsDir)) {
-    fs.mkdirSync(pluginsDir, {recursive: true});
-  }
-
-  const filename: string = context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
-  const pluginPath: string = path.join(pluginsDir, filename);
-  core.debug(`Plugin path is ${pluginPath}`);
-  fs.copyFileSync(toolBinPath, pluginPath);
-
-  core.info('Fixing perms');
-  fs.chmodSync(pluginPath, '0755');
-
-  return pluginPath;
-}
-
-async function download(version: string): Promise<string> {
-  const targetFile: string = context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
-  const downloadUrl = util.format('https://github.com/docker/buildx/releases/download/v%s/%s', version, await filename(version));
-  core.info(`Downloading ${downloadUrl}`);
-  const downloadPath = await tc.downloadTool(downloadUrl);
-  core.debug(`Downloaded to ${downloadPath}`);
-  return await tc.cacheFile(downloadPath, targetFile, 'buildx', version);
-}
-
-async function filename(version: string): Promise<string> {
-  let arch: string;
-  switch (context.osArch) {
-    case 'x64': {
-      arch = 'amd64';
-      break;
-    }
-    case 'ppc64': {
-      arch = 'ppc64le';
-      break;
-    }
-    case 'arm': {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const arm_version = (process.config.variables as any).arm_version;
-      arch = arm_version ? 'arm-v' + arm_version : 'arm';
-      break;
-    }
-    default: {
-      arch = context.osArch;
-      break;
-    }
-  }
-  const platform: string = context.osPlat == 'win32' ? 'windows' : context.osPlat;
-  const ext: string = context.osPlat == 'win32' ? '.exe' : '';
-  return util.format('buildx-v%s.%s-%s%s', version, platform, arch, ext);
-}
-
-export async function getBuildKitVersion(containerID: string): Promise<string> {
-  return exec
-    .getExecOutput(`docker`, ['inspect', '--format', '{{.Config.Image}}', containerID], {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(bkitimage => {
-      if (bkitimage.exitCode == 0 && bkitimage.stdout.length > 0) {
-        return exec
-          .getExecOutput(`docker`, ['run', '--rm', bkitimage.stdout.trim(), '--version'], {
-            ignoreReturnCode: true,
-            silent: true
-          })
-          .then(bkitversion => {
-            if (bkitversion.exitCode == 0 && bkitversion.stdout.length > 0) {
-              return `${bkitimage.stdout.trim()} => ${bkitversion.stdout.trim()}`;
-            } else if (bkitversion.stderr.length > 0) {
-              core.warning(bkitversion.stderr.trim());
-            }
-            return bkitversion.stdout.trim();
-          });
-      } else if (bkitimage.stderr.length > 0) {
-        core.warning(bkitimage.stderr.trim());
-      }
-      return bkitimage.stdout.trim();
-    });
-}
-
-export function getCommand(args: Array<string>, standalone?: boolean) {
-  return {
-    commandLine: standalone ? 'buildx' : 'docker',
-    args: standalone ? args : ['buildx', ...args]
-  };
-}

src/context.ts

@@ -1,69 +1,111 @@
-import fs from 'fs';
-import * as os from 'os';
-import path from 'path';
-import * as tmp from 'tmp';
+import * as uuid from 'uuid';
 import * as core from '@actions/core';
-import {issueCommand} from '@actions/core/lib/command';
+import {Docker} from '@docker/actions-toolkit/lib/docker/docker';
+import {Util} from '@docker/actions-toolkit/lib/util';
+import {Toolkit} from '@docker/actions-toolkit/lib/toolkit';
+import {Node} from '@docker/actions-toolkit/lib/types/builder';
 
-let _tmpDir: string;
-export const osPlat: string = os.platform();
-export const osArch: string = os.arch();
-
-export function tmpDir(): string {
-  if (!_tmpDir) {
-    _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-buildx-')).split(path.sep).join(path.posix.sep);
-  }
-  return _tmpDir;
-}
-
-export function tmpNameSync(options?: tmp.TmpNameOptions): string {
-  return tmp.tmpNameSync(options);
-}
+export const builderNodeEnvPrefix = 'BUILDER_NODE';
 
 export interface Inputs {
   version: string;
+  name: string;
   driver: string;
   driverOpts: string[];
   buildkitdFlags: string;
+  platforms: string[];
   install: boolean;
   use: boolean;
   endpoint: string;
   config: string;
   configInline: string;
+  append: string;
+  cleanup: boolean;
 }
 
 export async function getInputs(): Promise<Inputs> {
   return {
     version: core.getInput('version'),
+    name: await getBuilderName(core.getInput('driver') || 'docker-container'),
     driver: core.getInput('driver') || 'docker-container',
-    driverOpts: await getInputList('driver-opts', true),
+    driverOpts: Util.getInputList('driver-opts', {ignoreComma: true, quote: false}),
     buildkitdFlags: core.getInput('buildkitd-flags') || '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+    platforms: Util.getInputList('platforms'),
     install: core.getBooleanInput('install'),
     use: core.getBooleanInput('use'),
     endpoint: core.getInput('endpoint'),
     config: core.getInput('config'),
-    configInline: core.getInput('config-inline')
+    configInline: core.getInput('config-inline'),
+    append: core.getInput('append'),
+    cleanup: core.getBooleanInput('cleanup')
   };
 }
 
-export async function getInputList(name: string, ignoreComma?: boolean): Promise<string[]> {
-  const items = core.getInput(name);
-  if (items == '') {
-    return [];
-  }
-  return items
-    .split(/\r?\n/)
-    .filter(x => x)
-    .reduce<string[]>((acc, line) => acc.concat(!ignoreComma ? line.split(',').filter(x => x) : line).map(pat => pat.trim()), []);
+export async function getBuilderName(driver: string): Promise<string> {
+  return driver == 'docker' ? await Docker.context() : `builder-${uuid.v4()}`;
 }
 
-export const asyncForEach = async (array, callback) => {
-  for (let index = 0; index < array.length; index++) {
-    await callback(array[index], index, array);
+export async function getCreateArgs(inputs: Inputs, toolkit: Toolkit): Promise<Array<string>> {
+  const args: Array<string> = ['create', '--name', inputs.name, '--driver', inputs.driver];
+  if (await toolkit.buildx.versionSatisfies('>=0.3.0')) {
+    await Util.asyncForEach(inputs.driverOpts, async driverOpt => {
+      args.push('--driver-opt', driverOpt);
+    });
+    if (driverSupportsFlags(inputs.driver) && inputs.buildkitdFlags) {
+      args.push('--buildkitd-flags', inputs.buildkitdFlags);
+    }
   }
-};
-
-// FIXME: Temp fix https://github.com/actions/toolkit/issues/777
-export function setOutput(name: string, value: unknown): void {
-  issueCommand('set-output', {name}, value);
+  if (inputs.platforms.length > 0) {
+    args.push('--platform', inputs.platforms.join(','));
+  }
+  if (inputs.use) {
+    args.push('--use');
+  }
+  if (driverSupportsFlags(inputs.driver)) {
+    if (inputs.config) {
+      args.push('--config', toolkit.buildkit.config.resolveFromFile(inputs.config));
+    } else if (inputs.configInline) {
+      args.push('--config', toolkit.buildkit.config.resolveFromString(inputs.configInline));
+    }
+  }
+  if (inputs.endpoint) {
+    args.push(inputs.endpoint);
+  }
+  return args;
+}
+
+export async function getAppendArgs(inputs: Inputs, node: Node, toolkit: Toolkit): Promise<Array<string>> {
+  const args: Array<string> = ['create', '--name', inputs.name, '--append'];
+  if (node.name) {
+    args.push('--node', node.name);
+  } else if (inputs.driver == 'kubernetes' && (await toolkit.buildx.versionSatisfies('<0.11.0'))) {
+    args.push('--node', `node-${uuid.v4()}`);
+  }
+  if (node['driver-opts'] && (await toolkit.buildx.versionSatisfies('>=0.3.0'))) {
+    await Util.asyncForEach(node['driver-opts'], async driverOpt => {
+      args.push('--driver-opt', driverOpt);
+    });
+    if (driverSupportsFlags(inputs.driver) && node['buildkitd-flags']) {
+      args.push('--buildkitd-flags', node['buildkitd-flags']);
+    }
+  }
+  if (node.platforms) {
+    args.push('--platform', node.platforms);
+  }
+  if (node.endpoint) {
+    args.push(node.endpoint);
+  }
+  return args;
+}
+
+export async function getInspectArgs(inputs: Inputs, toolkit: Toolkit): Promise<Array<string>> {
+  const args: Array<string> = ['inspect', '--bootstrap'];
+  if (await toolkit.buildx.versionSatisfies('>=0.4.0')) {
+    args.push('--builder', inputs.name);
+  }
+  return args;
+}
+
+function driverSupportsFlags(driver: string): boolean {
+  return driver == '' || driver == 'docker-container' || driver == 'docker' || driver == 'kubernetes';
 }

src/docker.ts

@@ -1,19 +0,0 @@
-import * as exec from '@actions/exec';
-
-export async function isAvailable(): Promise<boolean> {
-  return await exec
-    .getExecOutput('docker', undefined, {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        return false;
-      }
-      return res.exitCode == 0;
-    })
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    .catch(error => {
-      return false;
-    });
-}

src/git.ts

@@ -1,19 +0,0 @@
-import * as exec from '@actions/exec';
-
-export async function getRemoteSha(repo: string, ref: string): Promise<string> {
-  return await exec
-    .getExecOutput(`git`, ['ls-remote', repo, ref], {
-      ignoreReturnCode: true,
-      silent: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        throw new Error(res.stderr);
-      }
-      const [rsha] = res.stdout.trim().split(/[\s\t]/);
-      if (rsha.length == 0) {
-        throw new Error(`Cannot find remote ref for ${repo}#${ref}`);
-      }
-      return rsha;
-    });
-}

src/github.ts

@@ -1,12 +0,0 @@
-import * as httpm from '@actions/http-client';
-
-export interface GitHubRelease {
-  id: number;
-  tag_name: string;
-}
-
-export const getRelease = async (version: string): Promise<GitHubRelease | null> => {
-  const url = `https://github.com/docker/buildx/releases/${version}`;
-  const http: httpm.HttpClient = new httpm.HttpClient('setup-buildx');
-  return (await http.getJson<GitHubRelease>(url)).result;
-};

src/main.ts

@@ -1,163 +1,201 @@
-import * as os from 'os';
-import * as path from 'path';
-import * as uuid from 'uuid';
-import * as buildx from './buildx';
-import * as context from './context';
-import * as docker from './docker';
-import * as stateHelper from './state-helper';
-import * as util from './util';
+import * as fs from 'fs';
+import * as yaml from 'js-yaml';
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
+import * as actionsToolkit from '@docker/actions-toolkit';
+import {Buildx} from '@docker/actions-toolkit/lib/buildx/buildx';
+import {Builder} from '@docker/actions-toolkit/lib/buildx/builder';
+import {Docker} from '@docker/actions-toolkit/lib/docker/docker';
+import {Toolkit} from '@docker/actions-toolkit/lib/toolkit';
+import {Util} from '@docker/actions-toolkit/lib/util';
+import {Node} from '@docker/actions-toolkit/lib/types/builder';
 
-async function run(): Promise<void> {
-  try {
+import * as context from './context';
+import * as stateHelper from './state-helper';
+
+actionsToolkit.run(
+  // main
+  async () => {
     const inputs: context.Inputs = await context.getInputs();
-    const dockerConfigHome: string = process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
+    stateHelper.setCleanup(inputs.cleanup);
 
-    // standalone if docker cli not available
-    const standalone = !(await docker.isAvailable());
+    const toolkit = new Toolkit();
+    const standalone = await toolkit.buildx.isStandalone();
     stateHelper.setStandalone(standalone);
 
-    core.startGroup(`Docker info`);
-    if (standalone) {
-      core.info(`Docker info skipped in standalone mode`);
-    } else {
-      await exec.exec('docker', ['version'], {
-        failOnStdErr: false
-      });
-      await exec.exec('docker', ['info'], {
-        failOnStdErr: false
-      });
-    }
-    core.endGroup();
+    await core.group(`Docker info`, async () => {
+      try {
+        await Docker.printVersion();
+        await Docker.printInfo();
+      } catch (e) {
+        core.info(e.message);
+      }
+    });
 
-    if (util.isValidUrl(inputs.version)) {
+    let toolPath;
+    if (Util.isValidRef(inputs.version)) {
       if (standalone) {
         throw new Error(`Cannot build from source without the Docker CLI`);
       }
-      core.startGroup(`Build and install buildx`);
-      await buildx.build(inputs.version, dockerConfigHome, standalone);
-      core.endGroup();
-    } else if (!(await buildx.isAvailable(standalone)) || inputs.version) {
-      core.startGroup(`Download and install buildx`);
-      await buildx.install(inputs.version || 'latest', standalone ? context.tmpDir() : dockerConfigHome, standalone);
-      core.endGroup();
+      await core.group(`Build buildx from source`, async () => {
+        toolPath = await toolkit.buildxInstall.build(inputs.version);
+      });
+    } else if (!(await toolkit.buildx.isAvailable()) || inputs.version) {
+      await core.group(`Download buildx from GitHub Releases`, async () => {
+        toolPath = await toolkit.buildxInstall.download(inputs.version || 'latest');
+      });
+    }
+    if (toolPath) {
+      await core.group(`Install buildx`, async () => {
+        if (standalone) {
+          await toolkit.buildxInstall.installStandalone(toolPath);
+        } else {
+          await toolkit.buildxInstall.installPlugin(toolPath);
+        }
+      });
     }
 
-    const buildxVersion = await buildx.getVersion(standalone);
     await core.group(`Buildx version`, async () => {
-      const versionCmd = buildx.getCommand(['version'], standalone);
-      await exec.exec(versionCmd.commandLine, versionCmd.args, {
-        failOnStdErr: false
-      });
+      await toolkit.buildx.printVersion();
     });
 
-    const builderName: string = inputs.driver == 'docker' ? 'default' : `builder-${uuid.v4()}`;
-    context.setOutput('name', builderName);
-    stateHelper.setBuilderName(builderName);
+    core.setOutput('name', inputs.name);
+    stateHelper.setBuilderName(inputs.name);
+    stateHelper.setBuilderDriver(inputs.driver);
+
+    fs.mkdirSync(Buildx.certsDir, {recursive: true});
+    stateHelper.setCertsDir(Buildx.certsDir);
 
     if (inputs.driver !== 'docker') {
-      core.startGroup(`Creating a new builder instance`);
-      const createArgs: Array<string> = ['create', '--name', builderName, '--driver', inputs.driver];
-      if (buildx.satisfies(buildxVersion, '>=0.3.0')) {
-        await context.asyncForEach(inputs.driverOpts, async driverOpt => {
-          createArgs.push('--driver-opt', driverOpt);
+      await core.group(`Creating a new builder instance`, async () => {
+        const certsDriverOpts = Buildx.resolveCertsDriverOpts(inputs.driver, inputs.endpoint, {
+          cacert: process.env[`${context.builderNodeEnvPrefix}_0_AUTH_TLS_CACERT`],
+          cert: process.env[`${context.builderNodeEnvPrefix}_0_AUTH_TLS_CERT`],
+          key: process.env[`${context.builderNodeEnvPrefix}_0_AUTH_TLS_KEY`]
         });
-        if (inputs.buildkitdFlags) {
-          createArgs.push('--buildkitd-flags', inputs.buildkitdFlags);
+        if (certsDriverOpts.length > 0) {
+          inputs.driverOpts = [...inputs.driverOpts, ...certsDriverOpts];
         }
-      }
-      if (inputs.use) {
-        createArgs.push('--use');
-      }
-      if (inputs.endpoint) {
-        createArgs.push(inputs.endpoint);
-      }
-      if (inputs.config) {
-        createArgs.push('--config', await buildx.getConfigFile(inputs.config));
-      } else if (inputs.configInline) {
-        createArgs.push('--config', await buildx.getConfigInline(inputs.configInline));
-      }
-      const createCmd = buildx.getCommand(createArgs, standalone);
-      await exec.exec(createCmd.commandLine, createCmd.args);
-      core.endGroup();
-
-      core.startGroup(`Booting builder`);
-      const bootstrapArgs: Array<string> = ['inspect', '--bootstrap'];
-      if (buildx.satisfies(buildxVersion, '>=0.4.0')) {
-        bootstrapArgs.push('--builder', builderName);
-      }
-      const bootstrapCmd = buildx.getCommand(bootstrapArgs, standalone);
-      await exec.exec(bootstrapCmd.commandLine, bootstrapCmd.args);
-      core.endGroup();
+        const createCmd = await toolkit.buildx.getCommand(await context.getCreateArgs(inputs, toolkit));
+        await exec.exec(createCmd.command, createCmd.args);
+      });
     }
 
+    if (inputs.append) {
+      await core.group(`Appending node(s) to builder`, async () => {
+        let nodeIndex = 1;
+        const nodes = yaml.load(inputs.append) as Node[];
+        for (const node of nodes) {
+          const certsDriverOpts = Buildx.resolveCertsDriverOpts(inputs.driver, `${node.endpoint}`, {
+            cacert: process.env[`${context.builderNodeEnvPrefix}_${nodeIndex}_AUTH_TLS_CACERT`],
+            cert: process.env[`${context.builderNodeEnvPrefix}_${nodeIndex}_AUTH_TLS_CERT`],
+            key: process.env[`${context.builderNodeEnvPrefix}_${nodeIndex}_AUTH_TLS_KEY`]
+          });
+          if (certsDriverOpts.length > 0) {
+            node['driver-opts'] = [...(node['driver-opts'] || []), ...certsDriverOpts];
+          }
+          const appendCmd = await toolkit.buildx.getCommand(await context.getAppendArgs(inputs, node, toolkit));
+          await exec.exec(appendCmd.command, appendCmd.args);
+          nodeIndex++;
+        }
+      });
+    }
+
+    await core.group(`Booting builder`, async () => {
+      const inspectCmd = await toolkit.buildx.getCommand(await context.getInspectArgs(inputs, toolkit));
+      await exec.exec(inspectCmd.command, inspectCmd.args);
+    });
+
     if (inputs.install) {
       if (standalone) {
         throw new Error(`Cannot set buildx as default builder without the Docker CLI`);
       }
-      core.startGroup(`Setting buildx as default builder`);
-      await exec.exec('docker', ['buildx', 'install']);
-      core.endGroup();
+      await core.group(`Setting buildx as default builder`, async () => {
+        const installCmd = await toolkit.buildx.getCommand(['install']);
+        await exec.exec(installCmd.command, installCmd.args);
+      });
     }
 
-    core.startGroup(`Inspect builder`);
-    const builder = await buildx.inspect(builderName, standalone);
-    core.info(JSON.stringify(builder, undefined, 2));
-    context.setOutput('driver', builder.driver);
-    context.setOutput('endpoint', builder.node_endpoint);
-    context.setOutput('status', builder.node_status);
-    context.setOutput('flags', builder.node_flags);
-    context.setOutput('platforms', builder.node_platforms);
-    core.endGroup();
+    const builderInspect = await toolkit.builder.inspect(inputs.name);
+    const firstNode = builderInspect.nodes[0];
 
-    if (!standalone && inputs.driver == 'docker-container') {
-      stateHelper.setContainerName(`buildx_buildkit_${builder.node_name}`);
-      core.startGroup(`BuildKit version`);
-      core.info(await buildx.getBuildKitVersion(`buildx_buildkit_${builder.node_name}`));
-      core.endGroup();
+    await core.group(`Inspect builder`, async () => {
+      const reducedPlatforms: Array<string> = [];
+      for (const node of builderInspect.nodes) {
+        for (const platform of node.platforms?.split(',') || []) {
+          if (reducedPlatforms.indexOf(platform) > -1) {
+            continue;
+          }
+          reducedPlatforms.push(platform);
+        }
+      }
+      core.info(JSON.stringify(builderInspect, undefined, 2));
+      core.setOutput('driver', builderInspect.driver);
+      core.setOutput('platforms', reducedPlatforms.join(','));
+      core.setOutput('nodes', JSON.stringify(builderInspect.nodes, undefined, 2));
+      core.setOutput('endpoint', firstNode.endpoint); // TODO: deprecated, to be removed in a later version
+      core.setOutput('status', firstNode.status); // TODO: deprecated, to be removed in a later version
+      core.setOutput('flags', firstNode['buildkitd-flags']); // TODO: deprecated, to be removed in a later version
+    });
+
+    if (!standalone && builderInspect.driver == 'docker-container') {
+      stateHelper.setContainerName(`${Buildx.containerNamePrefix}${firstNode.name}`);
+      await core.group(`BuildKit version`, async () => {
+        for (const node of builderInspect.nodes) {
+          const buildkitVersion = await toolkit.buildkit.getVersion(node);
+          core.info(`${node.name}: ${buildkitVersion}`);
+        }
+      });
     }
-    if (core.isDebug() || builder.node_flags?.includes('--debug')) {
+    if (core.isDebug() || firstNode['buildkitd-flags']?.includes('--debug')) {
       stateHelper.setDebug('true');
     }
-  } catch (error) {
-    core.setFailed(error.message);
-  }
-}
+  },
+  // post
+  async () => {
+    if (stateHelper.IsDebug && stateHelper.containerName.length > 0) {
+      await core.group(`BuildKit container logs`, async () => {
+        await exec
+          .getExecOutput('docker', ['logs', `${stateHelper.containerName}`], {
+            ignoreReturnCode: true
+          })
+          .then(res => {
+            if (res.stderr.length > 0 && res.exitCode != 0) {
+              core.warning(res.stderr.trim());
+            }
+          });
+      });
+    }
 
-async function cleanup(): Promise<void> {
-  if (stateHelper.IsDebug && stateHelper.containerName.length > 0) {
-    core.startGroup(`BuildKit container logs`);
-    await exec
-      .getExecOutput('docker', ['logs', `${stateHelper.containerName}`], {
-        ignoreReturnCode: true
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          core.warning(res.stderr.trim());
+    if (!stateHelper.cleanup) {
+      return;
+    }
+
+    if (stateHelper.builderDriver != 'docker' && stateHelper.builderName.length > 0) {
+      await core.group(`Removing builder`, async () => {
+        const buildx = new Buildx({standalone: stateHelper.standalone});
+        const builder = new Builder({buildx: buildx});
+        if (await builder.exists(stateHelper.builderName)) {
+          const rmCmd = await buildx.getCommand(['rm', stateHelper.builderName]);
+          await exec
+            .getExecOutput(rmCmd.command, rmCmd.args, {
+              ignoreReturnCode: true
+            })
+            .then(res => {
+              if (res.stderr.length > 0 && res.exitCode != 0) {
+                core.warning(res.stderr.trim());
+              }
+            });
+        } else {
+          core.info(`${stateHelper.builderName} does not exist`);
         }
       });
-    core.endGroup();
-  }
+    }
 
-  if (stateHelper.builderName.length > 0) {
-    core.startGroup(`Removing builder`);
-    const rmCmd = buildx.getCommand(['rm', stateHelper.builderName], /true/i.test(stateHelper.standalone));
-    await exec
-      .getExecOutput(rmCmd.commandLine, rmCmd.args, {
-        ignoreReturnCode: true
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          core.warning(res.stderr.trim());
-        }
+    if (stateHelper.certsDir.length > 0 && fs.existsSync(stateHelper.certsDir)) {
+      await core.group(`Cleaning up certificates`, async () => {
+        fs.rmSync(stateHelper.certsDir, {recursive: true});
       });
-    core.endGroup();
+    }
   }
-}
-
-if (!stateHelper.IsPost) {
-  run();
-} else {
-  cleanup();
-}
+);

src/state-helper.ts

@@ -1,10 +1,12 @@
 import * as core from '@actions/core';
 
-export const IsPost = !!process.env['STATE_isPost'];
 export const IsDebug = !!process.env['STATE_isDebug'];
-export const standalone = process.env['STATE_standalone'] || '';
+export const standalone = /true/i.test(process.env['STATE_standalone'] || '');
 export const builderName = process.env['STATE_builderName'] || '';
+export const builderDriver = process.env['STATE_builderDriver'] || '';
 export const containerName = process.env['STATE_containerName'] || '';
+export const certsDir = process.env['STATE_certsDir'] || '';
+export const cleanup = /true/i.test(process.env['STATE_cleanup'] || '');
 
 export function setDebug(debug: string) {
   core.saveState('isDebug', debug);
@@ -18,10 +20,18 @@ export function setBuilderName(builderName: string) {
   core.saveState('builderName', builderName);
 }
 
+export function setBuilderDriver(builderDriver: string) {
+  core.saveState('builderDriver', builderDriver);
+}
+
 export function setContainerName(containerName: string) {
   core.saveState('containerName', containerName);
 }
 
-if (!IsPost) {
-  core.saveState('isPost', 'true');
+export function setCertsDir(certsDir: string) {
+  core.saveState('certsDir', certsDir);
+}
+
+export function setCleanup(cleanup: boolean) {
+  core.saveState('cleanup', cleanup);
 }

src/util.ts

@@ -1,8 +0,0 @@
-export function isValidUrl(url: string): boolean {
-  try {
-    new URL(url);
-  } catch (e) {
-    return false;
-  }
-  return true;
-}

tsconfig.json

@@ -1,19 +1,21 @@
 {
   "compilerOptions": {
+    "esModuleInterop": true,
     "target": "es6",
     "module": "commonjs",
+    "strict": true,
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "strict": true,
     "noImplicitAny": false,
+    "resolveJsonModule": true,
     "useUnknownInCatchVariables": false,
   },
   "exclude": [
+    "./__tests__/**/*",
+    "./lib/**/*",
     "node_modules",
-    "**/*.test.ts",
     "jest.config.ts"
   ]
 }