Merge pull request #192 from crazy-max/support-ghes

enforce baseUrl to api.github.com if action used on GHES

.dockerignore

@@ -0,0 +1,2 @@
+/coverage
+/node_modules

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "env": {
+    "node": true,
+    "es2021": true,
+    "jest/globals": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "jest",
+    "prettier"
+  ]
+}

.github/CONTRIBUTING.md

@@ -2,35 +2,24 @@
 
 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
 
-Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
+Contributions to this project are [released](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license)
+to the public under the [project's open source license](LICENSE).
 
 ## Submitting a pull request
 
 1. [Fork](https://github.com/docker/setup-buildx-action/fork) and clone the repository
 2. Configure and install the dependencies: `yarn install`
 3. Create a new branch: `git checkout -b my-branch-name`
-4. Make your change, add tests, and make sure the tests still pass
+4. Make your changes
-5. Run pre-checkin: `yarn run pre-checkin`
+5. Make sure the tests pass: `docker buildx bake test`
-6. Push to your fork and [submit a pull request](https://github.com/docker/setup-buildx-action/compare)
+6. Format code and build javascript artifacts: `docker buildx bake pre-checkin`
-7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+7. Validate all code has correctly formatted and built: `docker buildx bake validate`
-
+8. Push to your fork and [submit a pull request](https://github.com/docker/setup-buildx-action/compare)
-## Container based developer flow
+9. Pat your self on the back and wait for your pull request to be reviewed and merged.
-
-If you don't want to maintain a Node developer environment that fits this project you can use containerized commands instead of invoking yarn directly.
-
-```
-# format code and build javascript artifacts
-docker buildx bake pre-checkin
-
-# validate all code has correctly formatted and built
-docker buildx bake validate
-
-# run tests
-docker buildx bake test
-```
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
+- Write tests.
 - Make sure the `README.md` and any other relevant **documentation are kept up-to-date**.
 - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
 - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**.
@@ -39,5 +28,5 @@ Here are a few things you can do that will increase the likelihood of your pull
 ## Resources
 
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
-- [GitHub Help](https://help.github.com)
+- [GitHub Help](https://docs.github.com/en)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,4 +30,5 @@ about: Create a report to help us improve
 
 ### Logs
 
-> Download the [log file of your build](https://help.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#downloading-logs) and [attach it](https://help.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests) to this issue.
+> Download the [log file of your build](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs)
+> and [attach it](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests) to this issue.

.github/dependabot.yml

@@ -4,19 +4,15 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-      time: "06:00"
-      timezone: "Europe/Paris"
     labels:
-      - ":game_die: dependencies"
+      - "dependencies"
-      - ":robot: bot"
+      - "bot"
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "daily"
-      time: "06:00"
-      timezone: "Europe/Paris"
     allow:
       - dependency-type: "production"
     labels:
-      - ":game_die: dependencies"
+      - "dependencies"
-      - ":robot: bot"
+      - "bot"

.github/labels.yml

@@ -1,77 +0,0 @@
-## more info https://github.com/crazy-max/ghaction-github-labeler
-- # automerge
-  name: ":bell: automerge"
-  color: "8f4fbc"
-  description: ""
-- # bot
-  name: ":robot: bot"
-  color: "69cde9"
-  description: ""
-- # bug
-  name: ":bug: bug"
-  color: "b60205"
-  description: ""
-- # dependencies
-  name: ":game_die: dependencies"
-  color: "0366d6"
-  description: ""
-- # documentation
-  name: ":memo: documentation"
-  color: "c5def5"
-  description: ""
-- # duplicate
-  name: ":busts_in_silhouette: duplicate"
-  color: "cccccc"
-  description: ""
-- # enhancement
-  name: ":sparkles: enhancement"
-  color: "0054ca"
-  description: ""
-- # feature request
-  name: ":bulb: feature request"
-  color: "0e8a16"
-  description: ""
-- # feedback
-  name: ":mega: feedback"
-  color: "03a9f4"
-  description: ""
-- # future maybe
-  name: ":rocket: future maybe"
-  color: "fef2c0"
-  description: ""
-- # good first issue
-  name: ":hatching_chick: good first issue"
-  color: "7057ff"
-  description: ""
-- # help wanted
-  name: ":pray: help wanted"
-  color: "4caf50"
-  description: ""
-- # hold
-  name: ":hand: hold"
-  color: "24292f"
-  description: ""
-- # invalid
-  name: ":no_entry_sign: invalid"
-  color: "e6e6e6"
-  description: ""
-- # maybe bug
-  name: ":interrobang: maybe bug"
-  color: "ff5722"
-  description: ""
-- # needs more info
-  name: ":thinking: needs more info"
-  color: "795548"
-  description: ""
-- # question
-  name: ":question: question"
-  color: "3f51b5"
-  description: ""
-- # upstream
-  name: ":eyes: upstream"
-  color: "fbca04"
-  description: ""
-- # wontfix
-  name: ":coffin: wontfix"
-  color: "ffffff"
-  description: ""

.github/workflows/ci.yml

@@ -1,18 +1,18 @@
 name: ci
 
 on:
+  schedule:
+    - cron: '0 10 * * *' # everyday at 10am
   push:
     branches:
-      - master
+      - 'master'
-      - releases/v*
+      - 'releases/v*'
-    paths-ignore:
+    tags:
-      - "**.md"
+      - 'v*'
   pull_request:
     branches:
-      - master
+      - 'master'
-      - releases/v*
+      - 'releases/v*'
-    paths-ignore:
-      - "**.md"
 
 jobs:
   main:
@@ -22,12 +22,12 @@ jobs:
       matrix:
         buildx-version:
           - latest
-          - v0.2.2
+          - v0.4.1
           - ""
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         id: buildx
@@ -35,42 +35,87 @@ jobs:
         with:
           version: ${{ matrix.buildx-version }}
       -
-        name: Builder instance name
+        name: Nodes output
-        run: echo ${{ steps.buildx.outputs.name }}
+        run: |
-      -
+          cat << EOF
-        name: Available platforms
+          ${{ steps.buildx.outputs.nodes }}
-        run: echo ${{ steps.buildx.outputs.platforms }}
+          EOF
-      -
-        name: Dump context
-        uses: crazy-max/ghaction-dump-context@v1
 
   multi:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx 1
-        id: buildx1
         uses: ./
-      -
-        name: Builder 1 instance name
-        run: echo ${{ steps.buildx1.outputs.name }}
       -
         name: Set up Docker Buildx 2
-        id: buildx2
+        uses: ./
+
+  error:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Stop docker
+        run: |
+          sudo systemctl stop docker
+      -
+        name: Set up Docker Buildx
+        id: buildx
+        continue-on-error: true
         uses: ./
       -
-        name: Builder 2 instance name
+        name: Check
-        run: echo ${{ steps.buildx2.outputs.name }}
+        run: |
+          echo "${{ toJson(steps.buildx) }}"
+          if [ "${{ steps.buildx.outcome }}" != "failure" ] || [ "${{ steps.buildx.conclusion }}" != "success" ]; then
+            echo "::error::Should have failed"
+            exit 1
+          fi
+      -
+        name: Dump context
+        if: always()
+        uses: crazy-max/ghaction-dump-context@v1
+
+  debug:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          RUN uname -a
+          EOL
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          buildkitd-flags: --debug
+      -
+        name: Build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/ppc64le
 
   install:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         uses: ./
@@ -92,7 +137,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         uses: ./
@@ -115,7 +160,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         uses: ./
@@ -128,7 +173,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up Docker Buildx
         uses: ./
@@ -161,7 +206,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Create context
         run: |
@@ -175,6 +220,67 @@ jobs:
         uses: ./
         with:
           endpoint: mycontext
+        env:
+          DOCKER_CONTEXT: mycontext
+
+  config:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Create buildkitd conf
+        run: |
+          cat > /tmp/buildkitd.toml <<EOL
+          debug = true
+          [registry."docker.io"]
+            mirrors = ["mirror.gcr.io"]
+          EOL
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          EOL
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          buildkitd-flags: --debug
+          config: /tmp/buildkitd.toml
+      -
+        name: Build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+
+  config-inline:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          EOL
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          buildkitd-flags: --debug
+          config-inline: |
+            debug = true
+            [registry."docker.io"]
+              mirrors = ["mirror.gcr.io"]
+      -
+        name: Build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
 
   with-qemu:
     runs-on: ubuntu-latest
@@ -183,7 +289,7 @@ jobs:
       matrix:
         buildx-version:
           - latest
-          - v0.2.2
+          - v0.4.1
           - ""
         qemu-platforms:
           - all
@@ -191,10 +297,10 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
         name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
         with:
           platforms: ${{ matrix.qemu-platforms }}
       -
@@ -204,8 +310,157 @@ jobs:
         with:
           version: ${{ matrix.buildx-version }}
       -
-        name: Available platforms
+        name: List builder platforms
         run: echo ${{ steps.buildx.outputs.platforms }}
+
+  build-ref:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ref:
+          - master
+          - refs/tags/v0.5.1
+          - refs/pull/731/head
+          - cb185f095fd3d9444e0aa605d3789e9e05f2a1e7
+    steps:
       -
-        name: Builder instance name
+        name: Checkout
-        run: echo ${{ steps.buildx.outputs.name }}
+        uses: actions/checkout@v3
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          version: https://github.com/docker/buildx.git#${{ matrix.ref }}
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          EOL
+      -
+        name: Build
+        uses: docker/build-push-action@master
+        with:
+          context: .
+
+  standalone-cmd:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Uninstall docker cli
+        run: |
+          sudo apt-get purge -y moby-cli moby-buildx
+      -
+        name: Set up Docker Buildx
+        uses: ./
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          EOL
+      -
+        name: Build
+        run: |
+          buildx build .
+
+  standalone-action:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Uninstall docker cli
+        run: |
+          sudo apt-get purge -y moby-cli moby-buildx
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          version: ${{ matrix.buildx-version }}
+      -
+        name: Create Dockerfile
+        run: |
+          cat > ./Dockerfile <<EOL
+          FROM alpine
+          EOL
+      -
+        name: Build
+        uses: docker/build-push-action@master
+        with:
+          context: .
+
+  standalone-install-error:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Uninstall docker cli
+        run: |
+          sudo apt-get purge -y moby-cli moby-buildx
+      -
+        name: Set up Docker Buildx
+        id: buildx
+        continue-on-error: true
+        uses: ./
+        with:
+          install: true
+      -
+        name: Check
+        run: |
+          echo "${{ toJson(steps.buildx) }}"
+          if [ "${{ steps.buildx.outcome }}" != "failure" ] || [ "${{ steps.buildx.conclusion }}" != "success" ]; then
+            echo "::error::Should have failed"
+            exit 1
+          fi
+
+  append:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        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@v3
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: ./
+        with:
+          platforms: linux/amd64

.github/workflows/labels.yml

@@ -1,20 +0,0 @@
-name: labels
-
-on:
-  push:
-    branches:
-      - 'master'
-    paths:
-      - '.github/labels.yml'
-      - '.github/workflows/labels.yml'
-
-jobs:
-  labeler:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v2.3.3
-      -
-        name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.0.0

.github/workflows/test.yml

@@ -3,44 +3,37 @@ name: test
 on:
   push:
     branches:
-      - master
+      - 'master'
-      - releases/v*
+      - 'releases/v*'
-    paths-ignore:
-      - "**.md"
   pull_request:
-    paths-ignore:
+    branches:
-      - "**.md"
+      - 'master'
+      - 'releases/v*'
 
 jobs:
-  test-containerized:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v2.3.3
-      -
-        name: Validate
-        run: docker buildx bake validate
-      -
-        name: Test
-        run: docker buildx bake test
-
   test:
     runs-on: ubuntu-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.3.3
+        uses: actions/checkout@v3
       -
-        name: Install
+        name: Validate
-        run: yarn install
+        uses: docker/bake-action@v2
+        with:
+          targets: validate
+      -
+        name: Set up Docker Buildx
+        uses: ./
       -
         name: Test
-        run: yarn run test
+        uses: docker/bake-action@v2
+        with:
+          targets: test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v1.0.13
+        uses: codecov/codecov-action@v3
-        if: success()
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage/clover.xml

.prettierrc.json

@@ -1,5 +1,5 @@
 {
-  "printWidth": 120,
+  "printWidth": 240,
   "tabWidth": 2,
   "useTabs": false,
   "semi": true,

Dockerfile

@@ -1,52 +0,0 @@
-#syntax=docker/dockerfile:1.1-experimental
-
-FROM node:14 AS deps
-WORKDIR /src
-COPY package.json yarn.lock ./
-RUN --mount=type=cache,target=/usr/local/share/.cache/yarn \
-  yarn install
-
-FROM scratch AS update-yarn
-COPY --from=deps /src/yarn.lock /
-
-FROM deps AS validate-yarn
-COPY .git .git
-RUN status=$(git status --porcelain -- yarn.lock); if [ -n "$status" ]; then echo $status; exit 1; fi
-
-FROM deps AS base
-COPY . .
-
-FROM base AS build
-RUN yarn build
-
-FROM deps AS test
-COPY --from=docker /usr/local/bin/docker /usr/bin/
-ARG TARGETOS
-ARG TARGETARCH
-ARG BUILDX_VERSION=v0.4.2
-ENV RUNNER_TEMP=/tmp/github_runner
-ENV RUNNER_TOOL_CACHE=/tmp/github_tool_cache
-RUN mkdir -p /usr/local/lib/docker/cli-plugins && \
-  curl -fsSL https://github.com/docker/buildx/releases/download/$BUILDX_VERSION/buildx-$BUILDX_VERSION.$TARGETOS-$TARGETARCH > /usr/local/lib/docker/cli-plugins/docker-buildx && \
-  chmod +x /usr/local/lib/docker/cli-plugins/docker-buildx && \
-  docker buildx version
-COPY . .
-RUN yarn run test
-
-FROM base AS run-format
-RUN yarn run format
-
-FROM scratch AS format
-COPY --from=run-format /src/src/*.ts /src/
-
-FROM base AS validate-format
-RUN yarn run format-check
-
-FROM scratch AS dist
-COPY --from=build /src/dist/ /dist/
-
-FROM build AS validate-build
-RUN status=$(git status --porcelain -- dist); if [ -n "$status" ]; then echo $status; exit 1; fi
-
-FROM base AS dev
-ENTRYPOINT ["bash"]

README.md

@@ -1,37 +1,38 @@
 [![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)
+[![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/workflow/status/docker/setup-buildx-action/test?label=test&logo=github&style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=test)
+[![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).
 
-> :bulb: See also:
+This action will create and boot a builder that can be used in the following
-> * [login](https://github.com/docker/login-action) action
+steps of your workflow if you're using Buildx or the [`build-push` action](https://github.com/docker/build-push-action/).
-> * [setup-qemu](https://github.com/docker/setup-qemu-action) action
+By default, the [`docker-container` driver](https://docs.docker.com/build/building/drivers/docker-container/)
-> * [build-push](https://github.com/docker/build-push-action) action
+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)
+* [Configuring your builder](#configuring-your-builder)
-  * [With QEMU](#with-qemu)
+* [Version pinning](#version-pinning)
-  * [Install by default](#install-by-default)
 * [Customizing](#customizing)
   * [inputs](#inputs)
   * [outputs](#outputs)
   * [environment variables](#environment-variables)
-* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
+* [Notes](#notes)
-* [Limitation](#limitation)
+  * [`nodes` output](#nodes-output)
+  * [BuildKit container logs](#buildkit-container-logs)
+* [Using on GHES](#using-on-ghes)
+* [Contributing](#contributing)
 
 ## Usage
 
-### Quick start
-
 ```yaml
 name: ci
 
@@ -44,141 +45,166 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
-      -
-        name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-        with:
-          version: latest
-      -
-        name: Builder instance name
-        run: echo ${{ steps.buildx.outputs.name }}
-      -
-        name: Available platforms
-        run: echo ${{ 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
       -
+        # 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
-        with:
-          platforms: all
       -
         name: Set up Docker Buildx
-        id: buildx
+        uses: docker/setup-buildx-action@v2
-        uses: docker/setup-buildx-action@v1
-        with:
-          version: latest
-      -
-        name: Available platforms
-        run: echo ${{ steps.buildx.outputs.platforms }}
 ```
 
-### Install by default
+## Configuring your builder
 
-Implemented with https://github.com/docker/buildx#setting-buildx-as-default-builder-in-docker-1903
+See https://docs.docker.com/build/ci/github-actions/configure-builder/
+
+## Version pinning
+
+This action builds images using [Buildx](https://github.com/docker/buildx) and
+[BuildKit](https://github.com/moby/buildkit). By default, the action will
+attempt to use the latest version of Buildx available on the GitHub Runner
+(the build client) and the latest release of BuildKit (the build server).
+
+To pin to a specific version of Buildx, use the `version` input. For example,
+to pin to Buildx v0.10.0:
 
 ```yaml
-name: ci
+- name: Set up Docker Buildx
+  uses: docker/setup-buildx-action@v3
+  with:
+    version: v0.10.0
+```
 
-on:
+To pin to a specific version of BuildKit, use the `image` option in the
-  push:
+`driver-opts` input. For example, to pin to BuildKit v0.11.0:
 
-jobs:
+```yaml
-  buildx:
+- name: Set up Docker Buildx
-    runs-on: ubuntu-latest
+  uses: docker/setup-buildx-action@v3
-    steps:
+  with:
-      -
+    driver-opts: image=moby/buildkit:v0.11.0
-        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
 ```
 
 ## Customizing
 
 ### inputs
 
-Following inputs can be used as `step.with` keys
+Following inputs can be used as `step.with` keys:
 
-| Name               | Type    | Description                       |
+> `List` type is a newline-delimited string
-|--------------------|---------|-----------------------------------|
-| `version`          | String  | [Buildx](https://github.com/docker/buildx) version. (eg. `v0.3.0`, `latest`) |
-| `driver`           | String  | Sets the [builder driver](https://github.com/docker/buildx#--driver-driver) to be used (default `docker-container`) |
-| `driver-opts`      | CSV     | List of additional [driver-specific options](https://github.com/docker/buildx#--driver-opt-options) (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#buildx-create-options-contextendpoint) or context from `docker context ls` |
-
-> `CSV` type must be a newline-delimited string
-> ```yaml
-> driver-opts: image=moby/buildkit:master
-> ```
 > ```yaml
 > driver-opts: |
 >   image=moby/buildkit:master
 >   network=host
 > ```
 
+> `CSV` type must be a newline-delimited string
+> ```yaml
+> platforms: linux/amd64,linux/arm64
+> ```
+
+| 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://docs.docker.com/engine/reference/commandline/buildx_create/#driver) to be used (default `docker-container`)                                                   |
+| `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 (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://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                                                                                                                         |
+
+> * ¹ `config` and `config-inline` are mutually exclusive
+
 ### outputs
 
 Following outputs are available
 
-| Name          | Type    | Description                           |
+| Name        | Type   | Description                                     |
-|---------------|---------|---------------------------------------|
+|-------------|--------|-------------------------------------------------|
-| `name`        | String  | Builder instance name |
+| `name`      | String | Builder name                                    |
-| `platforms`   | String  | Available platforms (comma separated) |
+| `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                                    |
+| Name            | Type   | Default     | Description                                     |
-|-----------------|---------|-------------|-------------------------------------------------|
+|-----------------|--------|-------------|-------------------------------------------------|
-| `DOCKER_CONFIG` | String  | `~/.docker` | The location of your client configuration files |
+| `DOCKER_CONFIG` | String | `~/.docker` | The location of your client configuration files |
 
-## Keep up-to-date with GitHub Dependabot
+## Notes
 
-Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
+### `nodes` output
-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
+```json
-version: 2
+[
-updates:
+  {
-  # Maintain dependencies for GitHub Actions
+     "name": "builder-3820d274-502c-4498-ae24-d4c32b3023d90",
-  - package-ecosystem: "github-actions"
+     "endpoint": "unix:///var/run/docker.sock",
-    directory: "/"
+     "driver-opts": [
-    schedule:
+       "network=host",
-      interval: "daily"
+       "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"
+  }
+]
 ```
 
-## Limitation
+| 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        |
 
-This action is only available for Linux [virtual environments](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#supported-virtual-environments-and-hardware-resources).
+### BuildKit container logs
+
+See https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs
+
+## Using on GHES
+
+GitHub Runners come [pre-installed with Docker Buildx](https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md)
+following your virtual environment. If you specify a version or `latest` of
+Docker Buildx in your workflow, the version will be downloaded from [GitHub Releases in `docker/buildx`](https://github.com/docker/buildx/releases)
+repository. These calls to `docker/buildx` are made via unauthenticated requests,
+which are limited to [60 requests per hour per IP](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).
+
+If more requests are made within the time frame, then you will start to see
+rate-limit errors during downloading that looks like:
+
+```
+##[error]API rate limit exceeded for...
+```
+
+To get a higher rate limit, you can [generate a personal access token on github.com](https://github.com/settings/tokens/new)
+and pass it as the `github_token` input for the action:
+
+```yaml
+uses: docker/setup-buildx-action@v3
+with:
+  github_token: ${{ secrets.GH_DOTCOM_TOKEN }}
+  version: v0.10.1
+```
+
+If the runner is not able to access `github.com`, it will take the default one
+available on the GitHub Runner or runner's tool cache. See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/enterprise-server@3.2/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)"
+for more information.
+
+## Contributing
+
+Want to contribute? Awesome! You can find information about contributing to
+this project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

__tests__/auth.test.ts

@@ -0,0 +1,88 @@
+import {describe, expect, test, beforeEach} from '@jest/globals';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import * as auth from '../src/auth';
+
+const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-buildx-jest')).split(path.sep).join(path.posix.sep);
+const dockerConfigHome = path.join(tmpdir, '.docker');
+const credsdir = path.join(dockerConfigHome, 'buildx', 'creds');
+
+describe('setCredentials', () => {
+  beforeEach(() => {
+    process.env = Object.keys(process.env).reduce((object, key) => {
+      if (!key.startsWith(auth.envPrefix)) {
+        object[key] = process.env[key];
+      }
+      return object;
+    }, {});
+  });
+
+  // prettier-ignore
+  test.each([
+    [
+      'mycontext',
+      'docker-container',
+      {},
+      [],
+      []
+    ],
+    [
+      'docker-container://mycontainer',
+      'docker-container',
+      {},
+      [],
+      []
+    ],
+    [
+      'tcp://graviton2:1234',
+      'remote',
+      {},
+      [],
+      []
+    ],
+    [
+      'tcp://graviton2:1234',
+      'remote',
+      {
+        'BUILDER_NODE_0_AUTH_TLS_CACERT': 'foo',
+        'BUILDER_NODE_0_AUTH_TLS_CERT': 'foo',
+        'BUILDER_NODE_0_AUTH_TLS_KEY': 'foo'
+      },
+      [
+        path.join(credsdir, 'cacert_graviton2-1234.pem'),
+        path.join(credsdir, 'cert_graviton2-1234.pem'),
+        path.join(credsdir, 'key_graviton2-1234.pem')
+      ],
+      [
+        `cacert=${path.join(credsdir, 'cacert_graviton2-1234.pem')}`,
+        `cert=${path.join(credsdir, 'cert_graviton2-1234.pem')}`,
+        `key=${path.join(credsdir, 'key_graviton2-1234.pem')}`
+      ]
+    ],
+    [
+      'tcp://graviton2:1234',
+      'docker-container',
+      {
+        'BUILDER_NODE_0_AUTH_TLS_CACERT': 'foo',
+        'BUILDER_NODE_0_AUTH_TLS_CERT': 'foo',
+        'BUILDER_NODE_0_AUTH_TLS_KEY': 'foo'
+      },
+      [
+        path.join(credsdir, 'cacert_graviton2-1234.pem'),
+        path.join(credsdir, 'cert_graviton2-1234.pem'),
+        path.join(credsdir, 'key_graviton2-1234.pem')
+      ],
+      []
+    ],
+  ])('given %p endpoint', async (endpoint: string, driver: string, envs: Record<string, string>, expectedFiles: Array<string>, expectedOpts: Array<string>) => {
+    fs.mkdirSync(credsdir, {recursive: true});
+    for (const [key, value] of Object.entries(envs)) {
+      process.env[key] = value;
+    }
+    expect(auth.setCredentials(credsdir, 0, driver, endpoint)).toEqual(expectedOpts);
+    expectedFiles.forEach( (file) => {
+      expect(fs.existsSync(file)).toBe(true);
+    });
+  });
+});

__tests__/buildx.test.ts

@@ -1,64 +1,261 @@
-import fs = require('fs');
+import {describe, expect, it, jest, test} from '@jest/globals';
-import * as docker from '../src/docker';
+import * as fs from 'fs';
-import * as buildx from '../src/buildx';
-import * as path from 'path';
 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 tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-buildx-')).split(path.sep).join(path.posix.sep);
+jest.spyOn(context, 'tmpDir').mockImplementation((): string => {
+  return tmpdir;
+});
+
+const tmpname = path.join(tmpdir, '.tmpname').split(path.sep).join(path.posix.sep);
+jest.spyOn(context, 'tmpNameSync').mockImplementation((): string => {
+  return tmpname;
+});
+
+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 () => {
-    await exec.exec('docker', ['buildx', 'version']);
     const version = await buildx.getVersion();
-    console.log(`version: ${version}`);
     expect(semver.valid(version)).not.toBeNull();
-  }, 100000);
+  });
 });
 
 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 v0.4.2 fb7b670b764764dc4716df3eba07ffdae4cc47b2', '0.4.2'],
+    ['github.com/docker/buildx f117971 f11797113e5a9b86bd976329c5dbb8a8bfdfadfa', 'f117971']
   ])('given %p', async (stdout, expected) => {
-    expect(await buildx.parseVersion(stdout)).toEqual(expected);
+    expect(buildx.parseVersion(stdout)).toEqual(expected);
   });
 });
 
-describe('platforms', () => {
+describe('satisfies', () => {
-  async function isDaemonRunning() {
+  test.each([
-    return await docker.isDaemonRunning();
+    ['0.4.1', '>=0.3.2', true],
-  }
+    ['bda4882a65349ca359216b135896bddc1d92461c', '>0.1.0', false],
-  (isDaemonRunning() ? it : it.skip)(
+    ['f117971', '>0.6.0', true]
-    'valid',
+  ])('given %p', async (version, range, expected) => {
-    async () => {
+    expect(buildx.satisfies(version, range)).toBe(expected);
-      const platforms = buildx.platforms();
+  });
-      console.log(`platforms: ${platforms}`);
-      expect(platforms).not.toBeUndefined();
-      expect(platforms).not.toEqual('');
-    },
-    100000
-  );
 });
 
-describe('countBuilders', () => {
+describe('inspect', () => {
   it('valid', async () => {
-    const countBuilders = await buildx.countBuilders();
+    const builder = await buildx.inspect('');
-    console.log(`countBuilders: ${countBuilders}`);
+    expect(builder).not.toBeUndefined();
-    expect(countBuilders).toBeGreaterThan(0);
+    expect(builder.name).not.toEqual('');
+    expect(builder.driver).not.toEqual('');
+    expect(builder.nodes).not.toEqual({});
+  }, 100000);
+});
+
+describe('parseInspect', () => {
+  // prettier-ignore
+  test.each([
+    [
+     'inspect1.txt',
+     {
+       "nodes": [
+         {
+           "name": "builder-5cb467f7-0940-47e1-b94b-d51f54054d620",
+           "endpoint": "unix:///var/run/docker.sock",
+           "status": "running",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkit": "v0.10.4",
+           "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/arm64,linux/riscv64,linux/386,linux/arm/v7,linux/arm/v6"
+         }
+       ],
+       "name": "builder-5cb467f7-0940-47e1-b94b-d51f54054d62",
+       "driver": "docker-container"
+     }
+    ],
+    [
+     'inspect2.txt',
+     {
+       "nodes": [
+         {
+           "name": "builder-5f449644-ff29-48af-8344-abb0292d06730",
+           "endpoint": "unix:///var/run/docker.sock",
+           "driver-opts": [
+             "image=moby/buildkit:latest"
+           ],
+           "status": "running",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkit": "v0.10.4",
+           "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386"
+         }
+       ],
+       "name": "builder-5f449644-ff29-48af-8344-abb0292d0673",
+       "driver": "docker-container"
+     }
+    ],
+    [
+     'inspect3.txt',
+     {
+       "nodes": [
+         {
+           "name": "builder-9929e463-7954-4dc3-89cd-514cca29ff800",
+           "endpoint": "unix:///var/run/docker.sock",
+           "driver-opts": [
+             "image=moby/buildkit:master",
+             "network=host"
+           ],
+           "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"
+         }
+       ],
+       "name": "builder-9929e463-7954-4dc3-89cd-514cca29ff80",
+       "driver": "docker-container"
+     }
+    ],
+    [
+     'inspect4.txt',
+     {
+       "nodes": [
+         {
+           "name": "default",
+           "endpoint": "default",
+           "status": "running",
+           "buildkit": "20.10.17",
+           "platforms": "linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/arm/v7,linux/arm/v6"
+         }
+       ],
+       "name": "default",
+       "driver": "docker"
+     }
+    ],
+    [
+     'inspect5.txt',
+     {
+       "nodes": [
+         {
+           "name": "aws_graviton2",
+           "endpoint": "tcp://1.23.45.67:1234",
+           "driver-opts": [
+             "cert=/home/user/.certs/aws_graviton2/cert.pem",
+             "key=/home/user/.certs/aws_graviton2/key.pem",
+             "cacert=/home/user/.certs/aws_graviton2/ca.pem"
+           ],
+           "status": "running",
+           "platforms": "darwin/arm64,linux/arm64,linux/arm/v5,linux/arm/v6,linux/arm/v7,windows/arm64"
+         }
+       ],
+       "name": "remote-builder",
+       "driver": "remote"
+     }
+    ],
+    [
+     'inspect6.txt',
+     {
+       "nodes": [
+         {
+           "name": "builder-17cfff01-48d9-4c3d-9332-9992e308a5100",
+           "endpoint": "unix:///var/run/docker.sock",
+           "status": "running",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/386"
+         }
+       ],
+       "name": "builder-17cfff01-48d9-4c3d-9332-9992e308a510",
+       "driver": "docker-container"
+     }
+    ],
+  ])('given %p', async (inspectFile, expected) => {
+    expect(await buildx.parseInspect(fs.readFileSync(path.join(__dirname, 'fixtures', inspectFile)).toString())).toEqual(expected);
+  });
+});
+
+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-'));
-  it('acquires v0.2.2 version of buildx', async () => {
+  test.each([
-    const buildxBin = await buildx.install('v0.2.2', tmpDir);
+    ['v0.4.1', false],
-    console.log(buildxBin);
+    ['latest', false],
-    expect(fs.existsSync(buildxBin)).toBe(true);
+    ['v0.4.1', true],
-  }, 100000);
+    ['latest', true]
-  it('acquires latest version of buildx', async () => {
+  ])(
-    const buildxBin = await buildx.install('latest', tmpDir);
+    'acquires %p of buildx (standalone: %p)',
-    console.log(buildxBin);
+    async (version, standalone) => {
-    expect(fs.existsSync(buildxBin)).toBe(true);
+      const buildxBin = await buildx.install(version, process.env.GITHUB_TOKEN || '', tmpDir, standalone);
-  }, 100000);
+      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(tmpname);
+      const configValue = fs.readFileSync(tmpname, '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,66 +1,260 @@
+import {beforeEach, 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 uuid from 'uuid';
 import * as context from '../src/context';
+import * as nodes from '../src/nodes';
+
+const tmpdir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-buildx-')).split(path.sep).join(path.posix.sep);
+jest.spyOn(context, 'tmpDir').mockImplementation((): string => {
+  return tmpdir;
+});
+
+jest.spyOn(context, 'tmpNameSync').mockImplementation((): string => {
+  return path.join(tmpdir, '.tmpname').split(path.sep).join(path.posix.sep);
+});
+
+jest.mock('uuid');
+jest.spyOn(uuid, 'v4').mockReturnValue('9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d');
+
+describe('getCreateArgs', () => {
+  beforeEach(() => {
+    process.env = Object.keys(process.env).reduce((object, key) => {
+      if (!key.startsWith('INPUT_')) {
+        object[key] = process.env[key];
+      }
+      return object;
+    }, {});
+  });
+
+  // prettier-ignore
+  test.each([
+    [
+      0,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', '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,
+      new Map<string, string>([
+        ['driver', 'docker'],
+        ['install', 'false'],
+        ['use', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'default',
+        '--driver', 'docker',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use'
+      ]
+    ],
+    [
+      2,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['driver-opts', 'image=moby/buildkit:master\nnetwork=host'],
+      ]),
+      [
+        '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,
+      new Map<string, string>([
+        ['driver', 'remote'],
+        ['endpoint', 'tls://foo:1234'],
+        ['install', 'false'],
+        ['use', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'remote',
+        '--use',
+        'tls://foo:1234'
+      ]
+    ],
+    [
+      4,
+      new Map<string, string>([
+        ['driver', 'remote'],
+        ['platforms', 'linux/arm64,linux/arm/v7'],
+        ['endpoint', 'tls://foo:1234'],
+        ['install', 'false'],
+        ['use', 'true'],
+      ]),
+      [
+        'create',
+        '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d',
+        '--driver', 'remote',
+        '--platform', 'linux/arm64,linux/arm/v7',
+        '--use',
+        'tls://foo:1234'
+      ]
+    ],
+    [
+      5,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['driver-opts', `"env.no_proxy=localhost,127.0.0.1,.mydomain"`],
+      ]),
+      [
+        '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,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'false'],
+        ['platforms', 'linux/amd64\n"linux/arm64,linux/arm/v7"'],
+      ]),
+      [
+        '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'
+      ]
+    ],
+  ])(
+    '[%d] given %p as inputs, returns %p',
+    async (num: number, inputs: Map<string, string>, expected: Array<string>) => {
+      inputs.forEach((value: string, name: string) => {
+        setInput(name, value);
+      });
+      const inp = await context.getInputs();
+      const res = await context.getCreateArgs(inp, '0.9.0');
+      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;
+    }, {});
+  });
+
+  // prettier-ignore
+  test.each([
+    [
+      0,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', '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 %p as inputs, returns %p',
+    async (num: number, inputs: Map<string, string>, node: nodes.Node, expected: Array<string>) => {
+      inputs.forEach((value: string, name: string) => {
+        setInput(name, value);
+      });
+      const inp = await context.getInputs();
+      const res = await context.getAppendArgs(inp, node, '0.9.0');
+      expect(res).toEqual(expected);
+    }
+  );
+});
 
 describe('getInputList', () => {
   it('handles single line correctly', async () => {
     await setInput('foo', 'bar');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar']);
   });
 
   it('handles multiple lines correctly', async () => {
     setInput('foo', 'bar\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('remove empty lines correctly', async () => {
     setInput('foo', 'bar\n\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('handles comma correctly', async () => {
     setInput('foo', 'bar,baz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('remove empty result correctly', async () => {
     setInput('foo', 'bar,baz,');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('handles different new lines correctly', async () => {
     setInput('foo', 'bar\r\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     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');
-    console.log(res);
     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);
-    console.log(res);
     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);
-    console.log(res);
     expect(res).toEqual(['image=moby/buildkit:master', 'network=host']);
   });
 });

__tests__/docker.test.ts

@@ -0,0 +1,16 @@
+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

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

__tests__/fixtures/inspect1.txt

@@ -0,0 +1,10 @@
+Name:   builder-5cb467f7-0940-47e1-b94b-d51f54054d62
+Driver: docker-container
+
+Nodes:
+Name:      builder-5cb467f7-0940-47e1-b94b-d51f54054d620
+Endpoint:  unix:///var/run/docker.sock
+Status:    running
+Flags:     --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host
+Buildkit:  v0.10.4
+Platforms: linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/amd64/v4, linux/arm64, linux/riscv64, linux/386, linux/arm/v7, linux/arm/v6

__tests__/fixtures/inspect2.txt

@@ -0,0 +1,11 @@
+Name:   builder-5f449644-ff29-48af-8344-abb0292d0673
+Driver: docker-container
+
+Nodes:
+Name:           builder-5f449644-ff29-48af-8344-abb0292d06730
+Endpoint:       unix:///var/run/docker.sock
+Driver Options: image="moby/buildkit:latest"
+Status:         running
+Flags:          --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host
+Buildkit:       v0.10.4
+Platforms:      linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/amd64/v4, linux/386

__tests__/fixtures/inspect3.txt

@@ -0,0 +1,11 @@
+Name:   builder-9929e463-7954-4dc3-89cd-514cca29ff80
+Driver: docker-container
+
+Nodes:
+Name:           builder-9929e463-7954-4dc3-89cd-514cca29ff800
+Endpoint:       unix:///var/run/docker.sock
+Driver Options: image="moby/buildkit:master" network="host"
+Status:         running
+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

__tests__/fixtures/inspect4.txt

@@ -0,0 +1,9 @@
+Name:   default
+Driver: docker
+
+Nodes:
+Name:      default
+Endpoint:  default
+Status:    running
+Buildkit:  20.10.17
+Platforms: linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7, linux/arm/v6

__tests__/fixtures/inspect5.txt

@@ -0,0 +1,9 @@
+Name:   remote-builder
+Driver: remote
+
+Nodes:
+Name:           aws_graviton2
+Endpoint:       tcp://1.23.45.67:1234
+Driver Options: cert="/home/user/.certs/aws_graviton2/cert.pem" key="/home/user/.certs/aws_graviton2/key.pem" cacert="/home/user/.certs/aws_graviton2/ca.pem"
+Status:         running
+Platforms:      darwin/arm64*, linux/arm64*, linux/arm/v5*, linux/arm/v6*, linux/arm/v7*, windows/arm64*, linux/amd64, linux/amd64/v2, linux/riscv64, linux/ppc64le, linux/s390x, linux/mips64le, linux/mips64

__tests__/fixtures/inspect6.txt

@@ -0,0 +1,9 @@
+Name:   builder-17cfff01-48d9-4c3d-9332-9992e308a510
+Driver: docker-container
+
+Nodes:
+Name:      builder-17cfff01-48d9-4c3d-9332-9992e308a5100
+Endpoint:  unix:///var/run/docker.sock
+Status:    running
+Flags:     --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host
+Platforms: linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/386

__tests__/git.test.ts

@@ -0,0 +1,9 @@
+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,17 +1,20 @@
+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');
+    const release = await github.getLatestRelease(process.env.GITHUB_TOKEN || '');
-    console.log(release);
     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');
+    const release = await github.getReleaseTag('v0.2.2', process.env.GITHUB_TOKEN || '');
-    console.log(release);
     expect(release).not.toBeNull();
     expect(release?.tag_name).toEqual('v0.2.2');
   });
+
+  it('unknown release', async () => {
+    await expect(github.getReleaseTag('foo', process.env.GITHUB_TOKEN || '')).rejects.toThrowError(new Error('Cannot get release foo: HttpError: Not Found'));
+  });
 });

__tests__/util.test.ts

@@ -0,0 +1,12 @@
+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,14 +32,45 @@ 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
+  github_token:
+    # https://github.com/actions/setup-go/blob/21459d0b7b1d63741429b748885bf5a4974593b4/action.yml#L12-L14
+    description: >
+      Used to verifiy the Git tag exists on docker/buildx repo. Since there's a
+      default, this is typically not supplied by the user. When running this
+      action on github.com, the default value is sufficient. When running on
+      GHES, you can pass a personal access token for github.com if you are
+      experiencing rate limiting.
+    default: ${{ github.server_url == 'https://github.com' && github.token || '' }}
 
 outputs:
   name:
-    description: 'Builder instance name'
+    description: 'Builder name'
+  driver:
+    description: 'Builder driver'
   platforms:
-    description: 'Available platforms (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: 'node12'
+  using: 'node16'
   main: 'dist/index.js'
   post: 'dist/index.js'

codecov.yml

@@ -0,0 +1,3 @@
+comment: false
+github_checks:
+  annotations: false

dev.Dockerfile

@@ -0,0 +1,79 @@
+# syntax=docker/dockerfile:1
+
+ARG NODE_VERSION=16
+ARG DOCKER_VERSION=20.10.13
+ARG BUILDX_VERSION=0.8.1
+
+FROM node:${NODE_VERSION}-alpine AS base
+RUN apk add --no-cache cpio findutils git
+WORKDIR /src
+
+FROM base AS deps
+RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/node_modules \
+  yarn install && mkdir /vendor && cp yarn.lock /vendor
+
+FROM scratch AS vendor-update
+COPY --from=deps /vendor /
+
+FROM deps AS vendor-validate
+RUN --mount=type=bind,target=.,rw <<EOT
+set -e
+git add -A
+cp -rf /vendor/* .
+if [ -n "$(git status --porcelain -- yarn.lock)" ]; then
+  echo >&2 'ERROR: Vendor result differs. Please vendor your package with "docker buildx bake vendor-update"'
+  git status --porcelain -- yarn.lock
+  exit 1
+fi
+EOT
+
+FROM deps AS build
+RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/node_modules \
+  yarn run build && mkdir /out && cp -Rf dist /out/
+
+FROM scratch AS build-update
+COPY --from=build /out /
+
+FROM build AS build-validate
+RUN --mount=type=bind,target=.,rw <<EOT
+set -e
+git add -A
+cp -rf /out/* .
+if [ -n "$(git status --porcelain -- dist)" ]; then
+  echo >&2 'ERROR: Build result differs. Please build first with "docker buildx bake build"'
+  git status --porcelain -- dist
+  exit 1
+fi
+EOT
+
+FROM deps AS format
+RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/node_modules \
+  yarn run format \
+  && mkdir /out && find . -name '*.ts' -not -path './node_modules/*' | cpio -pdm /out
+
+FROM scratch AS format-update
+COPY --from=format /out /
+
+FROM deps AS lint
+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 \
+  --mount=type=secret,id=GITHUB_TOKEN \
+  GITHUB_TOKEN=$(cat /run/secrets/GITHUB_TOKEN) yarn run test --coverageDirectory=/tmp/coverage
+
+FROM scratch AS test-coverage
+COPY --from=test /tmp/coverage /

docker-bake.hcl

@@ -3,40 +3,52 @@ group "default" {
 }
 
 group "pre-checkin" {
-  targets = ["update-yarn", "format", "build"]
+  targets = ["vendor-update", "format", "build"]
 }
 
 group "validate" {
-	targets = ["validate-format", "validate-build", "validate-yarn"]
+  targets = ["lint", "build-validate", "vendor-validate"]
-}
-
-target "update-yarn" {
-  target = "update-yarn"
-  output = ["."]
 }
 
 target "build" {
-  target = "dist"
+  dockerfile = "dev.Dockerfile"
+  target = "build-update"
   output = ["."]
 }
 
-target "test" {
+target "build-validate" {
-  target = "test"
+  dockerfile = "dev.Dockerfile"
+  target = "build-validate"
+  output = ["type=cacheonly"]
 }
 
 target "format" {
-  target = "format"
+  dockerfile = "dev.Dockerfile"
+  target = "format-update"
   output = ["."]
 }
 
-target "validate-format" {
+target "lint" {
-  target = "validate-format"
+  dockerfile = "dev.Dockerfile"
+  target = "lint"
+  output = ["type=cacheonly"]
 }
 
-target "validate-build" {
+target "vendor-update" {
-  target = "validate-build"
+  dockerfile = "dev.Dockerfile"
+  target = "vendor-update"
+  output = ["."]
 }
 
-target "validate-yarn" {
+target "vendor-validate" {
-	target = "validate-yarn"
+  dockerfile = "dev.Dockerfile"
-}
+  target = "vendor-validate"
+  output = ["type=cacheonly"]
+}
+
+target "test" {
+  dockerfile = "dev.Dockerfile"
+  target = "test-coverage"
+  output = ["./coverage"]
+  secret = ["id=GITHUB_TOKEN,env=GITHUB_TOKEN"]
+}

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/#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)

hack/shell

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-iidfile=$(mktemp -t docker-iidfile.XXXXXXXXXX)
-DOCKER_BUILDKIT=1 docker build --iidfile $iidfile --progress=plain .
-docker run -it --rm $(cat $iidfile)
-docker rmi $(cat $iidfile)

jest.config.ts

@@ -1,12 +1,13 @@
 module.exports = {
   clearMocks: true,
   moduleFileExtensions: ['js', 'ts'],
-  setupFiles: ["dotenv/config"],
+  setupFiles: ['dotenv/config'],
-  testEnvironment: 'node',
   testMatch: ['**/*.test.ts'],
-  testRunner: 'jest-circus/runner',
   transform: {
     '^.+\\.ts$': 'ts-jest'
   },
-  verbose: false
+  moduleNameMapper: {
-}
+    '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
+  },
+  verbose: true
+};

package.json

@@ -3,11 +3,11 @@
   "description": "Set up Docker Buildx",
   "main": "lib/main.js",
   "scripts": {
-    "build": "tsc && ncc build",
+    "build": "ncc build src/main.ts --source-map --minify --license licenses.txt",
-    "format": "prettier --write **/*.ts",
+    "lint": "eslint src/**/*.ts __tests__/**/*.ts",
-    "format-check": "prettier --check **/*.ts",
+    "format": "eslint --fix src/**/*.ts __tests__/**/*.ts",
     "test": "jest --coverage",
-    "pre-checkin": "yarn run format && yarn run build"
+    "all": "yarn run build && yarn run format && yarn test"
   },
   "repository": {
     "type": "git",
@@ -27,23 +27,32 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.2.6",
+    "@actions/core": "^1.10.0",
-    "@actions/exec": "^1.0.4",
+    "@actions/exec": "^1.1.1",
-    "@actions/http-client": "^1.0.8",
+    "@actions/github": "^5.1.1",
-    "@actions/tool-cache": "^1.5.5",
+    "@actions/tool-cache": "^2.0.1",
-    "semver": "^7.3.2"
+    "csv-parse": "^5.3.3",
+    "js-yaml": "^4.1.0",
+    "semver": "^7.3.7",
+    "tmp": "^0.2.1",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.3",
+    "@types/node": "^16.11.26",
-    "@types/node": "^14.0.14",
+    "@types/semver": "^7.3.9",
-    "@vercel/ncc": "^0.23.0",
+    "@types/tmp": "^0.2.3",
-    "dotenv": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "jest": "^26.1.0",
+    "@typescript-eslint/parser": "^5.14.0",
-    "jest-circus": "^26.1.0",
+    "@vercel/ncc": "^0.33.3",
-    "jest-runtime": "^26.1.0",
+    "dotenv": "^16.0.0",
-    "prettier": "^2.0.5",
+    "eslint": "^8.11.0",
-    "ts-jest": "^26.1.1",
+    "eslint-config-prettier": "^8.5.0",
-    "typescript": "^3.9.5",
+    "eslint-plugin-jest": "^26.1.1",
-    "typescript-formatter": "^7.2.2"
+    "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"
   }
 }

src/auth.ts

@@ -0,0 +1,51 @@
+import * as fs from 'fs';
+
+export const envPrefix = 'BUILDER_NODE';
+
+export function setCredentials(credsdir: string, index: number, driver: string, endpoint: string): Array<string> {
+  let url: URL;
+  try {
+    url = new URL(endpoint);
+  } catch (e) {
+    return [];
+  }
+  switch (url.protocol) {
+    case 'tcp:': {
+      return setBuildKitClientCerts(credsdir, index, driver, url);
+    }
+  }
+  return [];
+}
+
+function setBuildKitClientCerts(credsdir: string, index: number, driver: string, endpoint: URL): Array<string> {
+  const driverOpts: Array<string> = [];
+  const buildkitCacert = process.env[`${envPrefix}_${index}_AUTH_TLS_CACERT`] || '';
+  const buildkitCert = process.env[`${envPrefix}_${index}_AUTH_TLS_CERT`] || '';
+  const buildkitKey = process.env[`${envPrefix}_${index}_AUTH_TLS_KEY`] || '';
+  if (buildkitCacert.length == 0 && buildkitCert.length == 0 && buildkitKey.length == 0) {
+    return driverOpts;
+  }
+  let host = endpoint.hostname;
+  if (endpoint.port.length > 0) {
+    host += `-${endpoint.port}`;
+  }
+  if (buildkitCacert.length > 0) {
+    const cacertpath = `${credsdir}/cacert_${host}.pem`;
+    fs.writeFileSync(cacertpath, buildkitCacert);
+    driverOpts.push(`cacert=${cacertpath}`);
+  }
+  if (buildkitCert.length > 0) {
+    const certpath = `${credsdir}/cert_${host}.pem`;
+    fs.writeFileSync(certpath, buildkitCert);
+    driverOpts.push(`cert=${certpath}`);
+  }
+  if (buildkitKey.length > 0) {
+    const keypath = `${credsdir}/key_${host}.pem`;
+    fs.writeFileSync(keypath, buildkitKey);
+    driverOpts.push(`key=${keypath}`);
+  }
+  if (driver != 'remote') {
+    return [];
+  }
+  return driverOpts;
+}

src/buildx.ts

@@ -3,65 +3,248 @@ import * as path from 'path';
 import * as semver from 'semver';
 import * as util from 'util';
 import * as context from './context';
-import * as exec from './exec';
+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 async function getVersion(): Promise<string> {
+export type Builder = {
-  return await exec.exec(`docker`, ['buildx', 'version'], true).then(res => {
+  name?: string;
-    if (res.stderr != '' && !res.success) {
+  driver?: string;
-      throw new Error(res.stderr);
+  nodes: Node[];
-    }
+};
-    return parseVersion(res.stdout);
+
-  });
+export type Node = {
+  name?: string;
+  endpoint?: string;
+  'driver-opts'?: Array<string>;
+  status?: string;
+  'buildkitd-flags'?: string;
+  buildkit?: string;
+  platforms?: string;
+};
+
+export async function getConfigInline(s: string): Promise<string> {
+  return getConfig(s, false);
 }
 
-export async function parseVersion(stdout: string): Promise<string> {
+export async function getConfigFile(s: string): Promise<string> {
-  const matches = /\sv?([0-9.]+)/.exec(stdout);
+  return getConfig(s, true);
-  if (!matches) {
+}
-    throw new Error(`Cannot parse Buildx version`);
+
+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'});
   }
-  return semver.clean(matches[1]);
+  const configFile = context.tmpNameSync({
+    tmpdir: context.tmpDir()
+  });
+  fs.writeFileSync(configFile, s);
+  return configFile;
 }
 
-export async function isAvailable(): Promise<Boolean> {
+export async function isAvailable(standalone?: boolean): Promise<boolean> {
-  return await exec.exec(`docker`, ['buildx'], true).then(res => {
+  const cmd = getCommand([], standalone);
-    if (res.stderr != '' && !res.success) {
+  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;
-    }
+    });
-    return res.success;
-  });
 }
 
-export async function countBuilders(): Promise<number> {
+export async function getVersion(standalone?: boolean): Promise<string> {
-  return await exec.exec(`docker`, ['buildx', 'ls'], true).then(res => {
+  const cmd = getCommand(['version'], standalone);
-    if (res.stderr != '' && !res.success) {
+  return await exec
-      throw new Error(`Cannot list builders: ${res.stderr}`);
+    .getExecOutput(cmd.commandLine, cmd.args, {
-    }
+      ignoreReturnCode: true,
-    return (res.stdout.trim().split(`\n`).length - 1) / 2;
+      silent: true
-  });
+    })
+    .then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr.trim());
+      }
+      return parseVersion(res.stdout.trim());
+    });
 }
 
-export async function platforms(): Promise<String | undefined> {
+export function parseVersion(stdout: string): string {
-  return await exec.exec(`docker`, ['buildx', 'inspect'], true).then(res => {
+  const matches = /\sv?([0-9a-f]{7}|[0-9.]+)/.exec(stdout);
-    if (res.stderr != '' && !res.success) {
+  if (!matches) {
-      throw new Error(res.stderr);
+    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());
+      }
+      return parseInspect(res.stdout);
+    });
+}
+
+export async function parseInspect(data: string): Promise<Builder> {
+  const builder: Builder = {
+    nodes: []
+  };
+  let node: Node = {};
+  for (const line of data.trim().split(`\n`)) {
+    const [key, ...rest] = line.split(':');
+    const value = rest.map(v => v.trim()).join(':');
+    if (key.length == 0 || value.length == 0) {
+      continue;
     }
-    for (const line of res.stdout.trim().split(`\n`)) {
+    switch (key.toLowerCase()) {
-      if (line.startsWith('Platforms')) {
+      case 'name': {
-        return line.replace('Platforms: ', '').replace(/\s/g, '').trim();
+        if (builder.name == undefined) {
+          builder.name = value;
+        } else {
+          if (Object.keys(node).length > 0) {
+            builder.nodes.push(node);
+            node = {};
+          }
+          node.name = value;
+        }
+        break;
+      }
+      case 'driver': {
+        builder.driver = value;
+        break;
+      }
+      case 'endpoint': {
+        node.endpoint = value;
+        break;
+      }
+      case 'driver options': {
+        node['driver-opts'] = (value.match(/(\w+)="([^"]*)"/g) || []).map(v => v.replace(/^(.*)="(.*)"$/g, '$1=$2'));
+        break;
+      }
+      case 'status': {
+        node.status = value;
+        break;
+      }
+      case 'flags': {
+        node['buildkitd-flags'] = value;
+        break;
+      }
+      case 'buildkit': {
+        node.buildkit = value;
+        break;
+      }
+      case 'platforms': {
+        let platforms: Array<string> = [];
+        // if a preferred platform is being set then use only these
+        // https://docs.docker.com/engine/reference/commandline/buildx_inspect/#get-information-about-a-builder-instance
+        if (value.includes('*')) {
+          for (const platform of value.split(', ')) {
+            if (platform.includes('*')) {
+              platforms.push(platform.replace('*', ''));
+            }
+          }
+        } else {
+          // otherwise set all platforms available
+          platforms = value.split(', ');
+        }
+        node.platforms = platforms.join(',');
+        break;
       }
     }
-  });
+  }
+  if (Object.keys(node).length > 0) {
+    builder.nodes.push(node);
+  }
+  return builder;
 }
 
-export async function install(inputVersion: string, dockerConfigHome: string): Promise<string> {
+export async function build(inputBuildRef: string, dest: string, standalone: boolean): Promise<string> {
-  const release: github.GitHubRelease | null = await github.getRelease(inputVersion);
+  // eslint-disable-next-line prefer-const
-  if (!release) {
+  let [repo, ref] = inputBuildRef.split('#');
-    throw new Error(`Cannot find buildx ${inputVersion} release`);
+  if (ref.length == 0) {
+    ref = 'master';
   }
-  core.debug(`Release found: ${release.tag_name}`);
+
+  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, githubToken: string, dest: string, standalone: boolean): Promise<string> {
+  let release: github.Release;
+  if (inputVersion == 'latest') {
+    release = await github.getLatestRelease(githubToken);
+  } else {
+    release = await github.getReleaseTag(inputVersion, githubToken);
+  }
+  core.debug(`Release ${release.tag_name} found`);
   const version = release.tag_name.replace(/^v+|v+$/g, '');
 
   let toolPath: string;
@@ -74,6 +257,40 @@ export async function install(inputVersion: string, dockerConfigHome: string): P
     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)) {
@@ -83,9 +300,9 @@ export async function install(inputVersion: string, dockerConfigHome: string): P
   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(path.join(toolPath, filename), pluginPath);
+  fs.copyFileSync(toolBinPath, pluginPath);
 
-  core.info('🔨 Fixing perms...');
+  core.info('Fixing perms');
   fs.chmodSync(pluginPath, '0755');
 
   return pluginPath;
@@ -93,21 +310,10 @@ export async function install(inputVersion: string, dockerConfigHome: string): P
 
 async function download(version: string): Promise<string> {
   const targetFile: string = context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
-  const downloadUrl = util.format(
+  const downloadUrl = util.format('https://github.com/docker/buildx/releases/download/v%s/%s', version, await filename(version));
-    'https://github.com/docker/buildx/releases/download/v%s/%s',
+  core.info(`Downloading ${downloadUrl}`);
-    version,
+  const downloadPath = await tc.downloadTool(downloadUrl);
-    await filename(version)
+  core.debug(`Downloaded to ${downloadPath}`);
-  );
-  let downloadPath: string;
-
-  try {
-    core.info(`⬇️ Downloading ${downloadUrl}...`);
-    downloadPath = await tc.downloadTool(downloadUrl);
-    core.debug(`Downloaded to ${downloadPath}`);
-  } catch (error) {
-    throw error;
-  }
-
   return await tc.cacheFile(downloadPath, targetFile, 'buildx', version);
 }
 
@@ -123,6 +329,7 @@ async function filename(version: string): Promise<string> {
       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;
@@ -136,3 +343,38 @@ async function filename(version: string): Promise<string> {
   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,45 +1,154 @@
+import fs from 'fs';
 import * as os from 'os';
+import path from 'path';
+import * as tmp from 'tmp';
+import * as uuid from 'uuid';
+import {parse} from 'csv-parse/sync';
+import * as buildx from './buildx';
+import * as nodes from './nodes';
 import * as core from '@actions/core';
 
+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 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;
+  githubToken: string;
 }
 
 export async function getInputs(): Promise<Inputs> {
   return {
     version: core.getInput('version'),
+    name: getBuilderName(core.getInput('driver') || 'docker-container'),
     driver: core.getInput('driver') || 'docker-container',
     driverOpts: await getInputList('driver-opts', true),
-    buildkitdFlags:
+    buildkitdFlags: core.getInput('buildkitd-flags') || '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
-      core.getInput('buildkitd-flags') ||
+    platforms: await getInputList('platforms', false, true),
-      '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+    install: core.getBooleanInput('install'),
-    install: /true/i.test(core.getInput('install')),
+    use: core.getBooleanInput('use'),
-    use: /true/i.test(core.getInput('use')),
+    endpoint: core.getInput('endpoint'),
-    endpoint: core.getInput('endpoint')
+    config: core.getInput('config'),
+    configInline: core.getInput('config-inline'),
+    append: core.getInput('append'),
+    githubToken: core.getInput('github_token')
   };
 }
 
-export async function getInputList(name: string, ignoreComma?: boolean): Promise<string[]> {
+export function getBuilderName(driver: string): string {
+  return driver == 'docker' ? 'default' : `builder-${uuid.v4()}`;
+}
+
+export async function getCreateArgs(inputs: Inputs, buildxVersion: string): Promise<Array<string>> {
+  const args: Array<string> = ['create', '--name', inputs.name, '--driver', inputs.driver];
+  if (buildx.satisfies(buildxVersion, '>=0.3.0')) {
+    await asyncForEach(inputs.driverOpts, async driverOpt => {
+      args.push('--driver-opt', driverOpt);
+    });
+    if (inputs.driver != 'remote' && inputs.buildkitdFlags) {
+      args.push('--buildkitd-flags', inputs.buildkitdFlags);
+    }
+  }
+  if (inputs.platforms.length > 0) {
+    args.push('--platform', inputs.platforms.join(','));
+  }
+  if (inputs.use) {
+    args.push('--use');
+  }
+  if (inputs.driver != 'remote') {
+    if (inputs.config) {
+      args.push('--config', await buildx.getConfigFile(inputs.config));
+    } else if (inputs.configInline) {
+      args.push('--config', await buildx.getConfigInline(inputs.configInline));
+    }
+  }
+  if (inputs.endpoint) {
+    args.push(inputs.endpoint);
+  }
+  return args;
+}
+
+export async function getAppendArgs(inputs: Inputs, node: nodes.Node, buildxVersion: string): Promise<Array<string>> {
+  const args: Array<string> = ['create', '--name', inputs.name, '--append'];
+  if (node.name) {
+    args.push('--node', node.name);
+  }
+  if (node['driver-opts'] && buildx.satisfies(buildxVersion, '>=0.3.0')) {
+    await asyncForEach(node['driver-opts'], async driverOpt => {
+      args.push('--driver-opt', driverOpt);
+    });
+    if (inputs.driver != 'remote' && 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, buildxVersion: string): Promise<Array<string>> {
+  const args: Array<string> = ['inspect', '--bootstrap'];
+  if (buildx.satisfies(buildxVersion, '>=0.4.0')) {
+    args.push('--builder', inputs.name);
+  }
+  return args;
+}
+
+export async function getInputList(name: string, ignoreComma?: boolean, escapeQuotes?: boolean): Promise<string[]> {
+  const res: Array<string> = [];
+
   const items = core.getInput(name);
   if (items == '') {
-    return [];
+    return res;
   }
-  return items
+
-    .split(/\r?\n/)
+  const records = parse(items, {
-    .filter(x => x)
+    columns: false,
-    .reduce<string[]>(
+    relaxQuotes: true,
-      (acc, line) => acc.concat(!ignoreComma ? line.split(',').filter(x => x) : line).map(pat => pat.trim()),
+    comment: '#',
-      []
+    relaxColumnCount: true,
-    );
+    skipEmptyLines: true,
+    quote: escapeQuotes ? `"` : false
+  });
+
+  for (const record of records as Array<string[]>) {
+    if (record.length == 1) {
+      res.push(record[0]);
+      continue;
+    } else if (!ignoreComma) {
+      res.push(...record);
+      continue;
+    }
+    res.push(record.join(','));
+  }
+
+  return res.filter(item => item).map(pat => pat.trim());
 }
 
 export const asyncForEach = async (array, callback) => {

src/docker.ts

@@ -1,7 +1,19 @@
-import * as exec from './exec';
+import * as exec from '@actions/exec';
 
-export async function isDaemonRunning(): Promise<boolean> {
+export async function isAvailable(): Promise<boolean> {
-  return await exec.exec(`docker`, ['version', '--format', '{{.Server.Os}}'], true).then(res => {
+  return await exec
-    return !res.stdout.includes(' ') && res.success;
+    .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/exec.ts

@@ -1,34 +0,0 @@
-import * as aexec from '@actions/exec';
-import {ExecOptions} from '@actions/exec';
-
-export interface ExecResult {
-  success: boolean;
-  stdout: string;
-  stderr: string;
-}
-
-export const exec = async (command: string, args: string[] = [], silent: boolean): Promise<ExecResult> => {
-  let stdout: string = '';
-  let stderr: string = '';
-
-  const options: ExecOptions = {
-    silent: silent,
-    ignoreReturnCode: true
-  };
-  options.listeners = {
-    stdout: (data: Buffer) => {
-      stdout += data.toString();
-    },
-    stderr: (data: Buffer) => {
-      stderr += data.toString();
-    }
-  };
-
-  const returnCode: number = await aexec.exec(command, args, options);
-
-  return {
-    success: returnCode === 0,
-    stdout: stdout.trim(),
-    stderr: stderr.trim()
-  };
-};

src/git.ts

@@ -0,0 +1,19 @@
+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 +1,41 @@
-import * as httpm from '@actions/http-client';
+import * as github from '@actions/github';
 
-export interface GitHubRelease {
+export interface Release {
   id: number;
   tag_name: string;
 }
 
-export const getRelease = async (version: string): Promise<GitHubRelease | null> => {
+const [owner, repo] = 'docker/buildx'.split('/');
-  const url: string = `https://github.com/docker/buildx/releases/${version}`;
+
-  const http: httpm.HttpClient = new httpm.HttpClient('setup-buildx');
+export const getReleaseTag = async (tag: string, githubToken: string): Promise<Release> => {
-  return (await http.getJson<GitHubRelease>(url)).result;
+  return (
+    await github
+      .getOctokit(githubToken, {
+        baseUrl: 'https://api.github.com'
+      })
+      .rest.repos.getReleaseByTag({
+        owner,
+        repo,
+        tag
+      })
+      .catch(error => {
+        throw new Error(`Cannot get release ${tag}: ${error}`);
+      })
+  ).data as Release;
+};
+
+export const getLatestRelease = async (githubToken: string): Promise<Release> => {
+  return (
+    await github
+      .getOctokit(githubToken, {
+        baseUrl: 'https://api.github.com'
+      })
+      .rest.repos.getLatestRelease({
+        owner,
+        repo
+      })
+      .catch(error => {
+        throw new Error(`Cannot get latest release: ${error}`);
+      })
+  ).data as Release;
 };

src/main.ts

@@ -1,79 +1,178 @@
-import * as core from '@actions/core';
+import * as fs from 'fs';
-import * as exec from '@actions/exec';
 import * as os from 'os';
 import * as path from 'path';
-import * as semver from 'semver';
+import * as auth from './auth';
 import * as buildx from './buildx';
 import * as context from './context';
-import * as mexec from './exec';
+import * as docker from './docker';
+import * as nodes from './nodes';
 import * as stateHelper from './state-helper';
+import * as util from './util';
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
 
 async function run(): Promise<void> {
   try {
-    if (os.platform() !== 'linux') {
-      core.setFailed('Only supported on linux platform');
-      return;
-    }
-
     const inputs: context.Inputs = await context.getInputs();
     const dockerConfigHome: string = process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
 
-    if (!(await buildx.isAvailable()) || inputs.version) {
+    // standalone if docker cli not available
-      await buildx.install(inputs.version || 'latest', dockerConfigHome);
+    const standalone = !(await docker.isAvailable());
+    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();
+
+    if (util.isValidUrl(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', inputs.githubToken, standalone ? context.tmpDir() : dockerConfigHome, standalone);
+      core.endGroup();
     }
 
-    const buildxVersion = await buildx.getVersion();
+    const buildxVersion = await buildx.getVersion(standalone);
-    core.info(`📣 Buildx version: ${buildxVersion}`);
+    await core.group(`Buildx version`, async () => {
+      const versionCmd = buildx.getCommand(['version'], standalone);
+      await exec.exec(versionCmd.commandLine, versionCmd.args, {
+        failOnStdErr: false
+      });
+    });
 
-    const builderName: string =
+    core.setOutput('name', inputs.name);
-      inputs.driver == 'docker' ? 'default' : `builder-${process.env.GITHUB_JOB}-${(await buildx.countBuilders()) + 1}`;
+    stateHelper.setBuilderName(inputs.name);
-    core.setOutput('name', builderName);
+
-    stateHelper.setBuilderName(builderName);
+    const credsdir = path.join(dockerConfigHome, 'buildx', 'creds', inputs.name);
+    fs.mkdirSync(credsdir, {recursive: true});
+    stateHelper.setCredsDir(credsdir);
 
     if (inputs.driver !== 'docker') {
-      core.info('🔨 Creating a new builder instance...');
+      core.startGroup(`Creating a new builder instance`);
-      let createArgs: Array<string> = ['buildx', 'create', '--name', builderName, '--driver', inputs.driver];
+      const authOpts = auth.setCredentials(credsdir, 0, inputs.driver, inputs.endpoint);
-      await context.asyncForEach(inputs.driverOpts, async driverOpt => {
+      if (authOpts.length > 0) {
-        createArgs.push('--driver-opt', driverOpt);
+        inputs.driverOpts = [...inputs.driverOpts, ...authOpts];
-      });
-      if (inputs.buildkitdFlags && semver.satisfies(buildxVersion, '>=0.3.0')) {
-        createArgs.push('--buildkitd-flags', inputs.buildkitdFlags);
       }
-      if (inputs.use) {
+      const createCmd = buildx.getCommand(await context.getCreateArgs(inputs, buildxVersion), standalone);
-        createArgs.push('--use');
+      await exec.exec(createCmd.commandLine, createCmd.args);
-      }
+      core.endGroup();
-      if (inputs.endpoint) {
-        createArgs.push(inputs.endpoint);
-      }
-      await exec.exec('docker', createArgs);
-
-      core.info('🏃 Booting builder...');
-      await exec.exec('docker', ['buildx', 'inspect', '--bootstrap']);
     }
 
+    if (inputs.append) {
+      core.startGroup(`Appending node(s) to builder`);
+      let nodeIndex = 1;
+      for (const node of nodes.Parse(inputs.append)) {
+        const authOpts = auth.setCredentials(credsdir, nodeIndex, inputs.driver, node.endpoint || '');
+        if (authOpts.length > 0) {
+          node['driver-opts'] = [...(node['driver-opts'] || []), ...authOpts];
+        }
+        const appendCmd = buildx.getCommand(await context.getAppendArgs(inputs, node, buildxVersion), standalone);
+        await exec.exec(appendCmd.commandLine, appendCmd.args);
+        nodeIndex++;
+      }
+      core.endGroup();
+    }
+
+    core.startGroup(`Booting builder`);
+    const inspectCmd = buildx.getCommand(await context.getInspectArgs(inputs, buildxVersion), standalone);
+    await exec.exec(inspectCmd.commandLine, inspectCmd.args);
+    core.endGroup();
+
     if (inputs.install) {
-      core.info('🤝 Setting buildx as default builder...');
+      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();
     }
 
-    core.info('🛒 Extracting available platforms...');
+    core.startGroup(`Inspect builder`);
-    const platforms = await buildx.platforms();
+    const builder = await buildx.inspect(inputs.name, standalone);
-    core.info(`${platforms}`);
+    const firstNode = builder.nodes[0];
-    core.setOutput('platforms', platforms);
+    const reducedPlatforms: Array<string> = [];
+    for (const node of builder.nodes) {
+      for (const platform of node.platforms?.split(',') || []) {
+        if (reducedPlatforms.indexOf(platform) > -1) {
+          continue;
+        }
+        reducedPlatforms.push(platform);
+      }
+    }
+    core.info(JSON.stringify(builder, undefined, 2));
+    core.setOutput('driver', builder.driver);
+    core.setOutput('platforms', reducedPlatforms.join(','));
+    core.setOutput('nodes', JSON.stringify(builder.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
+    core.endGroup();
+
+    if (!standalone && builder.driver == 'docker-container') {
+      stateHelper.setContainerName(`buildx_buildkit_${firstNode.name}`);
+      core.startGroup(`BuildKit version`);
+      for (const node of builder.nodes) {
+        const bkvers = await buildx.getBuildKitVersion(`buildx_buildkit_${node.name}`);
+        core.info(`${node.name}: ${bkvers}`);
+      }
+      core.endGroup();
+    }
+    if (core.isDebug() || firstNode['buildkitd-flags']?.includes('--debug')) {
+      stateHelper.setDebug('true');
+    }
   } catch (error) {
     core.setFailed(error.message);
   }
 }
 
 async function cleanup(): Promise<void> {
-  if (stateHelper.builderName.length == 0) {
+  if (stateHelper.IsDebug && stateHelper.containerName.length > 0) {
-    return;
+    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());
+        }
+      });
+    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());
+        }
+      });
+    core.endGroup();
+  }
+
+  if (stateHelper.credsDir.length > 0 && fs.existsSync(stateHelper.credsDir)) {
+    core.info(`Cleaning up credentials`);
+    fs.rmSync(stateHelper.credsDir, {recursive: true});
   }
-  await mexec.exec('docker', ['buildx', 'rm', `${stateHelper.builderName}`], false).then(res => {
-    if (res.stderr != '' && !res.success) {
-      core.warning(res.stderr);
-    }
-  });
 }
 
 if (!stateHelper.IsPost) {

src/nodes.ts

@@ -0,0 +1,13 @@
+import * as yaml from 'js-yaml';
+
+export type Node = {
+  name?: string;
+  endpoint?: string;
+  'driver-opts'?: Array<string>;
+  'buildkitd-flags'?: string;
+  platforms?: string;
+};
+
+export function Parse(data: string): Node[] {
+  return yaml.load(data) as Node[];
+}

src/state-helper.ts

@@ -1,12 +1,32 @@
 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 builderName = process.env['STATE_builderName'] || '';
+export const containerName = process.env['STATE_containerName'] || '';
+export const credsDir = process.env['STATE_credsDir'] || '';
+
+export function setDebug(debug: string) {
+  core.saveState('isDebug', debug);
+}
+
+export function setStandalone(standalone: boolean) {
+  core.saveState('standalone', standalone);
+}
 
 export function setBuilderName(builderName: string) {
   core.saveState('builderName', builderName);
 }
 
+export function setContainerName(containerName: string) {
+  core.saveState('containerName', containerName);
+}
+
+export function setCredsDir(credsDir: string) {
+  core.saveState('credsDir', credsDir);
+}
+
 if (!IsPost) {
   core.saveState('isPost', 'true');
 }

src/util.ts

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

tsconfig.json

@@ -2,17 +2,18 @@
   "compilerOptions": {
     "target": "es6",
     "module": "commonjs",
-    "lib": [
-      "es6",
-      "dom"
-    ],
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
     "strict": true,
     "noImplicitAny": false,
-    "esModuleInterop": true,
+    "useUnknownInCatchVariables": false,
-    "sourceMap": true
   },
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "exclude": [
+    "node_modules",
+    "**/*.test.ts",
+    "jest.config.ts"
+  ]
 }