Merge pull request #190 from docker/dependabot/npm_and_yarn/docker/actions-toolkit-0.69.0

build(deps): bump @docker/actions-toolkit from 0.68.0 to 0.69.0

.github/workflows/ci.yml

@@ -29,16 +29,16 @@ jobs:
         os:
           - ubuntu-latest
           - ubuntu-24.04-arm
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
           - windows-latest
         version:
+          - ""
           - v27.3.1
           - type=image,tag=27.3.1
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -53,13 +53,12 @@ jobs:
         os:
           - ubuntu-latest
           - ubuntu-24.04-arm
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
           - windows-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -75,13 +74,12 @@ jobs:
         os:
           - ubuntu-latest
           - ubuntu-24.04-arm
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
           - windows-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -103,13 +101,12 @@ jobs:
         os:
           - ubuntu-latest
           - ubuntu-24.04-arm
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
           - windows-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -122,12 +119,11 @@ jobs:
           docker context inspect foo
 
   lima-start-args:
-    #runs-on: macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-    runs-on: macos-13
+    runs-on: macos-15-intel
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -147,7 +143,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Uninstall containerd
         if: matrix.containerd == 'containerd-tarball'
@@ -187,12 +183,11 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -226,7 +221,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -247,7 +242,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -264,7 +259,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         uses: ./
@@ -284,13 +279,12 @@ jobs:
         os:
           - ubuntu-latest
           - ubuntu-24.04-arm
-          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
-          - macos-13
+          - macos-15-intel
           - windows-latest
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Set up Docker
         id: setup_docker
@@ -304,3 +298,47 @@ jobs:
           docker info
         env:
           DOCKER_HOST: ${{ steps.setup_docker.outputs.tcp }}
+
+  undock-regctl-version:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        undock_version:
+          - ''
+          - v0.9.0
+        regctl_version:
+          - ''
+          - v0.8.2
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v6
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          version: type=image
+        env:
+          UNDOCK_VERSION: ${{ matrix.undock_version }}
+          REGCTL_VERSION: ${{ matrix.regctl_version }}
+
+  docker-29:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-15-intel
+          - windows-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v6
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          version: v29.0.0-rc.1
+          channel: test

.github/workflows/pr-assign-author.yml

@@ -0,0 +1,17 @@
+name: pr-assign-author
+
+permissions:
+  contents: read
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+
+jobs:
+  run:
+    uses: crazy-max/.github/.github/workflows/pr-assign-author.yml@1b673f36fad86812f538c1df9794904038a23cbf
+    permissions:
+      contents: read
+      pull-requests: write

.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Publish
         uses: actions/publish-immutable-action@v0.0.4

.github/workflows/test.yml

@@ -15,6 +15,9 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v6
       -
         name: Test
         uses: docker/bake-action@v6
@@ -24,5 +27,6 @@ jobs:
         name: Upload coverage
         uses: codecov/codecov-action@v5
         with:
+          source: .
           files: ./coverage/clover.xml
           token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/validate.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: List targets
         id: generate

README.md

@@ -113,15 +113,17 @@ jobs:
 
 The following inputs can be used as `step.with` keys
 
-| Name            | Type   | Default               | Description                                                                                                                 |
-|-----------------|--------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
-| `version`       | String | `latest`              | Docker version to use. See [inputs.version](#inputs.version).                                                               |
-| `channel`       | String | `stable`              | Docker CE [channel](https://download.docker.com/linux/static/) (`stable` or `test`). Only applicable to `type=archive`      |
-| `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
-| `tcp-port`      | Number |                       | TCP port to expose the Docker API locally                                                                                   |
-| `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |
-| `set-host`      | Bool   | `false`               | Set `DOCKER_HOST` environment variable to docker socket path.                                                               |
-| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |
+| Name              | Type   | Default                      | Description                                                                                                                                                  |
+|-------------------|--------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `version`         | String | `latest`                     | Docker version to use. See [inputs.version](#inputs.version).                                                                                                |
+| `channel`         | String | `stable`                     | Docker CE [channel](https://download.docker.com/linux/static/) (`stable` or `test`). Only applicable to `type=archive`                                       |
+| `daemon-config`   | String |                              | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)                                  |
+| `tcp-port`        | Number |                              | TCP port to expose the Docker API locally                                                                                                                    |
+| `context`         | String | `setup-docker-action`        | Docker context name.                                                                                                                                         |
+| `set-host`        | Bool   | `false`                      | Set `DOCKER_HOST` environment variable to docker socket path.                                                                                                |
+| `rootless`        | Bool   | `false`                      | Start daemon in rootless mode                                                                                                                                |
+| `runtime-basedir` | String | `<home>/setup-docker-action` | Docker runtime base directory                                                                                                                                |
+| `github-token`    | String | `${{ github.token }}`        | Optional GitHub Token used to get releases and download assets to avoid rate limitation. On GitHub Enterprise, you might need to set a PAT for `github.com`. |
 
 ### inputs.version
 

__tests__/context.test.ts

@@ -1,4 +1,6 @@
 import {beforeEach, describe, expect, test} from '@jest/globals';
+import * as os from 'os';
+import * as path from 'path';
 
 import * as context from '../src/context';
 
@@ -30,7 +32,9 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
-        setHost: false
+        setHost: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -52,7 +56,9 @@ describe('getInputs', () => {
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
         rootless: false,
-        setHost: false
+        setHost: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -70,7 +76,9 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
-        setHost: true
+        setHost: true,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -90,7 +98,9 @@ describe('getInputs', () => {
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
         rootless: false,
-        setHost: false
+        setHost: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -108,7 +118,9 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
-        setHost: false
+        setHost: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -128,6 +140,8 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -147,6 +161,8 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -165,6 +181,8 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -183,6 +201,8 @@ describe('getInputs', () => {
         context: '',
         daemonConfig: '',
         rootless: true,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
     [
@@ -203,7 +223,9 @@ describe('getInputs', () => {
         daemonConfig: '',
         tcpPort: 2378,
         rootless: false,
-        setHost: false
+        setHost: false,
+        runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
+        githubToken: '',
       } as context.Inputs
     ],
   ])(

action.yml

@@ -31,6 +31,13 @@ inputs:
     description: 'Enable Docker rootless mode'
     default: 'false'
     required: false
+  runtime-basedir:
+    description: 'Docker runtime base directory'
+    required: false
+  github-token:
+    description: "GitHub Token used to get releases and download assets"
+    default: ${{ github.token }}
+    required: false
 
 outputs:
   sock:

package.json

@@ -27,7 +27,7 @@
   "packageManager": "yarn@3.6.3",
   "dependencies": {
     "@actions/core": "^1.11.1",
-    "@docker/actions-toolkit": "^0.56.0"
+    "@docker/actions-toolkit": "^0.69.0"
   },
   "devDependencies": {
     "@types/node": "^20.6.0",

src/context.ts

@@ -1,3 +1,5 @@
+import os from 'os';
+import path from 'path';
 import * as core from '@actions/core';
 import {parse} from 'csv-parse/sync';
 
@@ -11,6 +13,8 @@ export interface Inputs {
   context: string;
   setHost: boolean;
   rootless: boolean;
+  runtimeBasedir: string;
+  githubToken: string;
 }
 
 export function getInputs(): Inputs {
@@ -27,7 +31,9 @@ export function getInputs(): Inputs {
     tcpPort: Util.getInputNumber('tcp-port'),
     context: core.getInput('context'),
     setHost: core.getBooleanInput('set-host'),
-    rootless: core.getBooleanInput('rootless')
+    rootless: core.getBooleanInput('rootless'),
+    runtimeBasedir: core.getInput('runtime-basedir') || path.join(os.homedir(), `setup-docker-action`),
+    githubToken: core.getInput('github-token')
   };
 }
 

src/main.ts

@@ -1,24 +1,51 @@
 import * as crypto from 'crypto';
-import os from 'os';
 import path from 'path';
 import * as core from '@actions/core';
 import * as actionsToolkit from '@docker/actions-toolkit';
 import {Install} from '@docker/actions-toolkit/lib/docker/install';
 import {Docker} from '@docker/actions-toolkit/lib/docker/docker';
+import {Install as RegclientInstall} from '@docker/actions-toolkit/lib/regclient/install';
+import {Install as UndockInstall} from '@docker/actions-toolkit/lib/undock/install';
 
 import * as context from './context';
 import * as stateHelper from './state-helper';
 
+const regctlDefaultVersion = 'v0.8.3';
+const undockDefaultVersion = 'v0.10.0';
+
 actionsToolkit.run(
   // main
   async () => {
     const input: context.Inputs = context.getInputs();
-    const runDir = path.join(os.homedir(), `setup-docker-action-${crypto.randomUUID().slice(0, 8)}`);
+    const runDir = path.join(input.runtimeBasedir, `run-${crypto.randomUUID().slice(0, 8)}`);
 
     if (input.context == 'default') {
       throw new Error(`'default' context cannot be used.`);
     }
 
+    if (input.source.type === 'image') {
+      await core.group(`Download and install regctl`, async () => {
+        const regclientInstall = new RegclientInstall({githubToken: input.githubToken});
+        const regclientBinPath = await regclientInstall.download(
+          process.env.REGCTL_VERSION && process.env.REGCTL_VERSION.trim()
+            ? process.env.REGCTL_VERSION
+            : regctlDefaultVersion,
+          true
+        );
+        await regclientInstall.install(regclientBinPath);
+      });
+      await core.group(`Download and install undock`, async () => {
+        const undockInstall = new UndockInstall({githubToken: input.githubToken});
+        const undockBinPath = await undockInstall.download(
+          process.env.UNDOCK_VERSION && process.env.UNDOCK_VERSION.trim()
+            ? process.env.UNDOCK_VERSION
+            : undockDefaultVersion,
+          true
+        );
+        await undockInstall.install(undockBinPath);
+      });
+    }
+
     let tcpPort: number | undefined;
     let tcpAddress: string | undefined;
     if (input.tcpPort) {
@@ -32,7 +59,8 @@ actionsToolkit.run(
       rootless: input.rootless,
       contextName: input.context || 'setup-docker-action',
       daemonConfig: input.daemonConfig,
-      localTCPPort: tcpPort
+      localTCPPort: tcpPort,
+      githubToken: input.githubToken
     });
     let toolDir;
     if (!(await Docker.isAvailable()) || input.source) {