Merge pull request #120 from crazy-max/remove-uuid

remove uuid package and switch to crypto

.github/dependabot.yml

@@ -4,6 +4,11 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    ignore:
+      # ignore this dependency
+      # it seems a bug with dependabot as pining to commit sha should not
+      # trigger a new version similar to https://github.com/docker/buildx/pull/2222#issuecomment-1919092153
+      - dependency-name: "docker/actions-toolkit"
     labels:
       - "dependencies"
       - "bot"

.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: ci
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   workflow_dispatch:
   schedule:
@@ -13,7 +17,7 @@ on:
   pull_request:
 
 env:
-  DOCKER_VERSION: v23.0.6
+  DOCKER_VERSION: v24.0.9
 
 jobs:
   main:
@@ -23,8 +27,8 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
           - macos-13
-          - macos-latest
           - windows-latest
         version:
           - pinned
@@ -33,6 +37,11 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        if: startsWith(matrix.os, 'macos')
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set version
         shell: bash
@@ -57,17 +66,23 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          - macos-latest
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+          - macos-13
           - windows-latest
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        if: startsWith(matrix.os, 'macos')
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set up Docker
         uses: ./
         with:
-          version: v23.0.0-rc.4
+          version: v24.0.0-rc.4
           channel: test
       -
         name: Dump context
@@ -81,12 +96,18 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          - macos-latest
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+          - macos-13
           - windows-latest
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        if: startsWith(matrix.os, 'macos')
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set up Docker
         uses: ./
@@ -110,12 +131,18 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          - macos-latest
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+          - macos-13
           - windows-latest
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        if: startsWith(matrix.os, 'macos')
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set up Docker
         uses: ./
@@ -132,11 +159,16 @@ jobs:
         uses: crazy-max/ghaction-dump-context@v2
 
   lima-start-args:
-    runs-on: macos-latest
+    #runs-on: macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+    runs-on: macos-13
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set up Docker
         uses: ./
@@ -145,10 +177,21 @@ jobs:
 
   build-linux:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        containerd:
+          - containerd-system
+          - containerd-tarball
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        name: Uninstall containerd
+        if: matrix.containerd == 'containerd-tarball'
+        run: |
+          sudo apt-get remove -y containerd.io
       -
         name: Set up Docker
         uses: ./
@@ -166,7 +209,7 @@ jobs:
           driver-opts: network=host
       -
         name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ./test
           push: true
@@ -187,12 +230,18 @@ jobs:
       fail-fast: false
       matrix:
         os:
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
           - macos-13
-          - macos-latest
+          - macos-12
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+        name: Set up QEMU
+        if: startsWith(matrix.os, 'macos')
+        uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
       -
         name: Set up Docker
         uses: ./
@@ -210,7 +259,7 @@ jobs:
           driver-opts: network=host
       -
         name: Build and push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ./test
           push: true
@@ -249,3 +298,23 @@ jobs:
         name: Dump context
         if: always()
         uses: crazy-max/ghaction-dump-context@v2
+
+  set-host:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          set-host: true
+      -
+        name: List contexts
+        run: |
+          docker context ls
+      -
+        name: Dump context
+        if: always()
+        uses: crazy-max/ghaction-dump-context@v2

.github/workflows/test.yml

@@ -1,5 +1,9 @@
 name: test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
@@ -16,11 +20,12 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Test
-        uses: docker/bake-action@v4
+        uses: docker/bake-action@v5
         with:
           targets: test
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           file: ./coverage/clover.xml
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/validate.yml

@@ -1,5 +1,9 @@
 name: validate
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
@@ -36,6 +40,6 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Validate
-        uses: docker/bake-action@v4
+        uses: docker/bake-action@v5
         with:
           targets: ${{ matrix.target }}

.yarnrc.yml

@@ -11,5 +11,3 @@ nodeLinker: node-modules
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
     spec: "@yarnpkg/plugin-interactive-tools"
-
-yarnPath: .yarn/releases/yarn-3.6.3.cjs

README.md

@@ -9,6 +9,11 @@
 GitHub Action to set up (download and install) [Docker CE](https://docs.docker.com/engine/).
 Works on Linux, macOS and Windows.
 
+> [!WARNING]
+> Does not work on macOS runners with ARM architecture (no nested virtualization):
+> * https://github.com/crazy-max/ghaction-setup-docker/pull/53
+> * https://github.com/docker/actions-toolkit/issues/317
+
 ![Screenshot](.github/setup-docker-action.png)
 
 ___
@@ -19,6 +24,7 @@ ___
   * [Define custom `limactl start` arguments (macOS)](#define-custom-limactl-start-arguments-macos)
 * [Customizing](#customizing)
   * [inputs](#inputs)
+  * [outputs](#outputs)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -38,9 +44,32 @@ jobs:
     steps:
       -
         name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v2
+        uses: crazy-max/ghaction-setup-docker@v3
 ```
 
+> [!IMPORTANT]
+> macOS runners hang with latest QEMU 9.1.0. You need to install QEMU 9.0.2 as
+> a workaround:
+> ```yaml
+> name: ci
+> 
+> on:
+>   push:
+> 
+> jobs:
+>   docker:
+>     runs-on: macos-13
+>     steps:
+>       -
+>         # https://github.com/crazy-max/ghaction-setup-docker/issues/108
+>         name: Install QEMU 9.0.2
+>         uses: docker/actions-toolkit/.github/actions/macos-setup-qemu@19ca9ade20f5da695f76a10988d6532058575f82
+>       -
+>         name: Set up Docker
+>         uses: crazy-max/ghaction-setup-docker@v3
+> ```
+> More info: https://github.com/crazy-max/ghaction-setup-docker/issues/108.
+
 ### Daemon configuration
 
 You can [configure the Docker daemon](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)
@@ -60,7 +89,7 @@ jobs:
     steps:
       -
         name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v2
+        uses: crazy-max/ghaction-setup-docker@v3
         with:
           daemon-config: |
             {
@@ -88,7 +117,7 @@ jobs:
     steps:
       -
         name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v2
+        uses: crazy-max/ghaction-setup-docker@v3
         env:
           LIMA_START_ARGS: --cpus 4 --memory 8
 ```
@@ -105,6 +134,15 @@ The following inputs can be used as `step.with` keys
 | `channel`       | String | `stable`              | Docker CE [channel](https://download.docker.com/linux/static/) (e.g, `stable`, `edge` or `test`).                           |
 | `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
 | `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |
+| `set-host`      | Bool   | `false`               | Set `DOCKER_HOST` environment variable to docker socket path.                                                               |
+
+### outputs
+
+The following outputs are available
+
+| Name   | Type   | Description        |
+|--------|--------|--------------------|
+| `sock` | String | Docker socket path |
 
 ## Contributing
 

__tests__/context.test.ts

@@ -17,38 +17,45 @@ describe('getInputs', () => {
     [
       0,
       new Map<string, string>([
-        ['version', 'v23.0.1'],
+        ['version', 'v24.0.8'],
+        ['set-host', 'false'],
       ]),
       {
-        version: 'v23.0.1',
+        version: 'v24.0.8',
         channel: '',
         context: '',
         daemonConfig: '',
+        setHost: false
       } as context.Inputs
     ],
     [
       1,
       new Map<string, string>([
-        ['version', 'v23.0.0-rc.4'],
+        ['version', 'v24.0.0-rc.4'],
         ['channel', 'test'],
         ['context', 'foo'],
         ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
+        ['set-host', 'false'],
       ]),
       {
-        version: 'v23.0.0-rc.4',
+        version: 'v24.0.0-rc.4',
         channel: 'test',
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        setHost: false
       } as context.Inputs
     ],
     [
       2,
-      new Map<string, string>([]),
+      new Map<string, string>([
+        ['set-host', 'true'],
+      ]),
       {
         version: 'latest',
         channel: '',
         context: '',
         daemonConfig: '',
+        setHost: true
       } as context.Inputs
     ]
   ])(

action.yml

@@ -8,7 +8,7 @@ branding:
 
 inputs:
   version:
-    description: 'Docker CE version. (e.g, v23.0.1)'
+    description: 'Docker CE version. (e.g, v24.0.9)'
     required: false
     default: 'latest'
   channel:
@@ -20,6 +20,14 @@ inputs:
   context:
     description: 'Docker context name. (default setup-docker-action)'
     required: false
+  set-host:
+    description: 'Set DOCKER_HOST environment variable to docker socket path'
+    default: 'false'
+    required: false
+
+outputs:
+  sock:
+    description: "Docker socket path"
 
 runs:
   using: 'node20'

dev.Dockerfile

@@ -4,8 +4,13 @@ ARG NODE_VERSION=20
 
 FROM node:${NODE_VERSION}-alpine AS base
 RUN apk add --no-cache cpio findutils git
-RUN yarn config set --home enableTelemetry 0
 WORKDIR /src
+RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/.yarn/cache <<EOT
+  corepack enable
+  yarn --version
+  yarn config set --home enableTelemetry 0
+EOT
 
 FROM base AS deps
 RUN --mount=type=bind,target=.,rw \

package.json

@@ -26,9 +26,8 @@
   "license": "Apache-2.0",
   "packageManager": "yarn@3.6.3",
   "dependencies": {
-    "@actions/core": "^1.10.1",
+    "@actions/core": "^1.11.1",
-    "@docker/actions-toolkit": "^0.16.0",
+    "@docker/actions-toolkit": "^0.40.0"
-    "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@types/node": "^20.6.0",

src/context.ts

@@ -5,6 +5,7 @@ export interface Inputs {
   channel: string;
   daemonConfig?: string;
   context: string;
+  setHost: boolean;
 }
 
 export function getInputs(): Inputs {
@@ -12,6 +13,7 @@ export function getInputs(): Inputs {
     version: core.getInput('version') || 'latest',
     channel: core.getInput('channel'),
     daemonConfig: core.getInput('daemon-config'),
-    context: core.getInput('context')
+    context: core.getInput('context'),
+    setHost: core.getBooleanInput('set-host')
   };
 }

src/main.ts

@@ -1,6 +1,6 @@
+import * as crypto from 'crypto';
 import os from 'os';
 import path from 'path';
-import * as uuid from 'uuid';
 import * as core from '@actions/core';
 import * as actionsToolkit from '@docker/actions-toolkit';
 import {Install} from '@docker/actions-toolkit/lib/docker/install';
@@ -13,7 +13,7 @@ actionsToolkit.run(
   // main
   async () => {
     const input: context.Inputs = context.getInputs();
-    const runDir = path.join(os.homedir(), `setup-docker-action-${uuid.v4()}`);
+    const runDir = path.join(os.homedir(), `setup-docker-action-${crypto.randomUUID().slice(0, 8)}`);
 
     if (input.context == 'default') {
       throw new Error(`'default' context cannot be used.`);
@@ -34,7 +34,18 @@ actionsToolkit.run(
     }
     if (toolDir) {
       stateHelper.setRunDir(runDir);
-      await install.install();
+      const sockPath = await install.install();
+      await core.group(`Setting outputs`, async () => {
+        core.info(`sock=${sockPath}`);
+        core.setOutput('sock', sockPath);
+      });
+
+      if (input.setHost) {
+        await core.group(`Setting Docker host`, async () => {
+          core.exportVariable('DOCKER_HOST', sockPath);
+          core.info(`DOCKER_HOST=${sockPath}`);
+        });
+      }
     }
 
     await core.group(`Docker info`, async () => {