Merge pull request #119 from crazy-max/update-readme

readme: remove qemu set up workaround

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ on:
   pull_request:
 
 env:
-  DOCKER_VERSION: v24.0.9
+  DOCKER_VERSION: v27.3.1
 
 jobs:
   main:
@@ -31,33 +31,17 @@ jobs:
           - macos-13
           - windows-latest
         version:
-          - pinned
-          - latest
+          - v27.3.1
+          - type=image,tag=27.3.1
     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 version
-        shell: bash
-        run: |
-          if [ "${{ matrix.version }}" != "pinned" ]; then
-            echo "DOCKER_VERSION=${{ matrix.version }}" >> $GITHUB_ENV
-          fi
       -
         name: Set up Docker
         uses: ./
         with:
-          version: ${{ env.DOCKER_VERSION }}
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
+          version: ${{ matrix.version }}
 
   channel:
     runs-on: ${{ matrix.os }}
@@ -73,21 +57,12 @@ 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 up Docker
         uses: ./
         with:
-          version: v24.0.0-rc.4
+          version: ${{ env.DOCKER_VERSION }}
           channel: test
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   daemon-config:
     runs-on: ${{ matrix.os }}
@@ -103,15 +78,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 up Docker
         uses: ./
         with:
+          version: ${{ env.DOCKER_VERSION }}
           daemon-config: |
             {
               "debug": true,
@@ -119,10 +90,6 @@ jobs:
                 "containerd-snapshotter": true
               }
             }
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   context:
     runs-on: ${{ matrix.os }}
@@ -138,11 +105,6 @@ 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 up Docker
         uses: ./
@@ -153,10 +115,6 @@ jobs:
         name: Check context
         run: |
           docker context inspect foo
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   lima-start-args:
     #runs-on: macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
@@ -165,13 +123,11 @@ jobs:
       -
         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: ./
+        with:
+          version: ${{ env.DOCKER_VERSION }}
         env:
           LIMA_START_ARGS: --cpus 4 --memory 8
 
@@ -219,10 +175,6 @@ jobs:
         name: Inspect
         run: |
           docker buildx imagetools inspect localhost:5000/name/app:latest --format '{{json .}}'
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   build-macos:
     runs-on: ${{ matrix.os }}
@@ -232,16 +184,10 @@ jobs:
         os:
           #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
           - macos-13
-          - 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: ./
@@ -269,10 +215,6 @@ jobs:
         name: Inspect
         run: |
           docker buildx imagetools inspect localhost:5000/name/app:latest --format '{{json .}}'
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   build-windows:
     runs-on: windows-latest
@@ -294,10 +236,6 @@ jobs:
         name: Inspect
         run: |
           docker image inspect test
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   set-host:
     runs-on: ubuntu-latest
@@ -309,12 +247,26 @@ jobs:
         name: Set up Docker
         uses: ./
         with:
+          version: ${{ env.DOCKER_VERSION }}
           set-host: true
       -
         name: List contexts
         run: |
           docker context ls
+
+  rootless:
+    runs-on: ubuntu-latest
+    steps:
       -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          version: ${{ env.DOCKER_VERSION }}
+          rootless: true
+      -
+        name: List contexts
+        run: |
+          docker context ls

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
           targets: test
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
-          file: ./coverage/clover.xml
+          files: ./coverage/clover.xml
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -47,29 +47,6 @@ jobs:
         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)
@@ -135,6 +112,7 @@ The following inputs can be used as `step.with` keys
 | `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.                                                               |
+| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |
 
 ### outputs
 

__tests__/context.test.ts

@@ -19,12 +19,17 @@ describe('getInputs', () => {
       new Map<string, string>([
         ['version', 'v24.0.8'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v24.0.8',
-        channel: '',
+        source: {
+          type: 'archive',
+          version: 'v24.0.8',
+          channel: 'stable'
+        },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -36,12 +41,17 @@ describe('getInputs', () => {
         ['context', 'foo'],
         ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v24.0.0-rc.4',
-        channel: 'test',
+        source: {
+          type: 'archive',
+          version: 'v24.0.0-rc.4',
+          channel: 'test'
+        },
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -49,15 +59,132 @@ describe('getInputs', () => {
       2,
       new Map<string, string>([
         ['set-host', 'true'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'latest',
-        channel: '',
+        source: {
+          type: 'archive',
+          version: 'latest',
+          channel: 'stable',
+        },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: true
       } as context.Inputs
-    ]
+    ],
+    [
+    3,
+      new Map<string, string>([
+        ['version', 'type=image,tag=master'],
+        ['context', 'foo'],
+        ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: 'master',
+        },
+        context: 'foo',
+        daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
+        setHost: false
+      } as context.Inputs
+    ],
+    [
+      4,
+      new Map<string, string>([
+        ['version', 'type=image'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: 'latest',
+        },
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+        setHost: false
+      } as context.Inputs
+    ],
+    [
+      5,
+      new Map<string, string>([
+        ['version', 'type=archive'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'archive',
+          version: 'latest',
+          channel: 'stable',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      6,
+      new Map<string, string>([
+        ['version', 'version=v27.2.0,channel=test'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'archive',
+          version: 'v27.2.0',
+          channel: 'test',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      7,
+      new Map<string, string>([
+        ['version', 'type=image,tag=27.2.1'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: '27.2.1',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      8,
+      new Map<string, string>([
+        ['version', 'type=image,tag=27.2.1'],
+        ['set-host', 'false'],
+        ['rootless', 'true']
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: '27.2.1',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: true,
+      } as context.Inputs
+    ],
   ])(
     '[%d] given %p as inputs, returns %p',
     async (num: number, inputs: Map<string, string>, expected: context.Inputs) => {

action.yml

@@ -24,6 +24,10 @@ inputs:
     description: 'Set DOCKER_HOST environment variable to docker socket path'
     default: 'false'
     required: false
+  rootless:
+    description: 'Enable Docker rootless mode'
+    default: 'false'
+    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.40.0"
+    "@docker/actions-toolkit": "^0.46.0"
   },
   "devDependencies": {
     "@types/node": "^20.6.0",

src/context.ts

@@ -1,19 +1,98 @@
 import * as core from '@actions/core';
+import {InstallSource} from '@docker/actions-toolkit/lib/docker/install';
+import {parse} from 'csv-parse/sync';
 
 export interface Inputs {
-  version: string;
-  channel: string;
+  source: InstallSource;
   daemonConfig?: string;
   context: string;
   setHost: boolean;
+  rootless: boolean;
 }
 
 export function getInputs(): Inputs {
+  const rawVersion = core.getInput('version') || 'latest';
+  const source = parseSource(rawVersion);
+  const channel = core.getInput('channel');
+  if (channel && source.type === 'archive') {
+    source.channel = channel;
+  }
+
   return {
-    version: core.getInput('version') || 'latest',
-    channel: core.getInput('channel'),
+    source: source,
     daemonConfig: core.getInput('daemon-config'),
     context: core.getInput('context'),
-    setHost: core.getBooleanInput('set-host')
+    setHost: core.getBooleanInput('set-host'),
+    rootless: core.getBooleanInput('rootless')
   };
 }
+
+function parseSource(input: string): InstallSource {
+  let [type, version, channel, tag] = ['archive', 'latest', 'stable', 'latest'];
+
+  const fields = parse(input, {
+    relaxColumnCount: true,
+    skipEmptyLines: true
+  })[0];
+  for (const field of fields) {
+    const parts = field
+      .toString()
+      .split(/(?<=^[^=]+?)=/)
+      .map(item => item.trim());
+
+    switch (parts[0]) {
+      case 'type':
+        type = parts[1];
+        break;
+      case 'version':
+        version = parts[1];
+        break;
+      case 'channel':
+        channel = parts[1];
+        break;
+      case 'tag':
+        tag = parts[1];
+        break;
+      default:
+        if (fields.length === 1) {
+          version = parts[0];
+          break;
+        }
+        throw new Error(`Invalid field: ${parts[0]}`);
+    }
+  }
+
+  if (!type) {
+    throw new Error(`Invalid type: ${type}`);
+  }
+  if (!channel) {
+    throw new Error(`Invalid channel: ${channel}`);
+  }
+  if (!version) {
+    throw new Error(`Invalid version: ${version}`);
+  }
+  if (!tag) {
+    throw new Error(`Invalid tag: ${tag}`);
+  }
+
+  let src: InstallSource;
+  switch (type) {
+    case 'archive':
+      src = {
+        type: 'archive',
+        version: version,
+        channel: channel
+      };
+      break;
+    case 'image':
+      src = {
+        type: 'image',
+        tag: tag
+      };
+      break;
+    default:
+      throw new Error(`Invalid version: ${input}`);
+  }
+
+  return src;
+}

src/main.ts

@@ -21,13 +21,13 @@ actionsToolkit.run(
 
     const install = new Install({
       runDir: runDir,
-      version: input.version,
-      channel: input.channel || 'stable',
+      source: input.source,
+      rootless: input.rootless,
       contextName: input.context || 'setup-docker-action',
       daemonConfig: input.daemonConfig
     });
     let toolDir;
-    if (!(await Docker.isAvailable()) || input.version) {
+    if (!(await Docker.isAvailable()) || input.source) {
       await core.group(`Download docker`, async () => {
         toolDir = await install.download();
       });

yarn.lock

@@ -33,11 +33,11 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@actions/cache@npm:^3.2.4":
-  version: 3.2.4
-  resolution: "@actions/cache@npm:3.2.4"
+"@actions/cache@npm:^3.3.0":
+  version: 3.3.0
+  resolution: "@actions/cache@npm:3.3.0"
   dependencies:
-    "@actions/core": ^1.10.0
+    "@actions/core": ^1.11.1
     "@actions/exec": ^1.0.1
     "@actions/glob": ^0.1.0
     "@actions/http-client": ^2.1.1
@@ -46,8 +46,7 @@ __metadata:
     "@azure/ms-rest-js": ^2.6.0
     "@azure/storage-blob": ^12.13.0
     semver: ^6.3.1
-    uuid: ^3.3.3
-  checksum: 5bf5f7541bea4906b553440a9ffee5699e11dfb729365c6cb0bbd37e147a1a0993369fdad16bfa3e2b01ec7fa57dac66276278bfd4a389009246a75ea953e61d
+  checksum: f0761b1491b7706a80b44d68ed52eb48c04653fc939525a7c7b606e9d9251c40c7e4ac20846ab92ac32db6869e1a6f0f574bd6b7fec1ab9378c8e199c5acc9c9
   languageName: node
   linkType: hard
 
@@ -1103,12 +1102,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@docker/actions-toolkit@npm:^0.40.0":
-  version: 0.40.0
-  resolution: "@docker/actions-toolkit@npm:0.40.0"
+"@docker/actions-toolkit@npm:^0.46.0":
+  version: 0.46.0
+  resolution: "@docker/actions-toolkit@npm:0.46.0"
   dependencies:
     "@actions/artifact": ^2.1.11
-    "@actions/cache": ^3.2.4
+    "@actions/cache": ^3.3.0
     "@actions/core": ^1.11.1
     "@actions/exec": ^1.1.1
     "@actions/github": ^6.0.0
@@ -1119,7 +1118,7 @@ __metadata:
     "@octokit/core": ^5.1.0
     "@octokit/plugin-rest-endpoint-methods": ^10.4.0
     async-retry: ^1.3.3
-    csv-parse: ^5.5.6
+    csv-parse: ^5.6.0
     gunzip-maybe: ^1.4.2
     handlebars: ^4.7.8
     he: ^1.2.0
@@ -1128,7 +1127,7 @@ __metadata:
     semver: ^7.6.3
     tar-stream: ^3.1.7
     tmp: ^0.2.3
-  checksum: 38ac578e3659ddfefbcb39dbd51a9226e6eaedf797c99ad07e29fa710e7131abadf5fd30338c0197938574791760ed16e049179fb883fe288b73bb3761faf179
+  checksum: cd34682d1b801c17c81f7f6791c4c81a69018f02413a1f7a7c2c1086bf0ee98c9afb5b44e6d5b8827df188819913eec47fa5b54b63f522b4a87c216de0b5725f
   languageName: node
   linkType: hard
 
@@ -3220,20 +3219,20 @@ __metadata:
   linkType: hard
 
 "cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.2, cross-spawn@npm:^7.0.3":
-  version: 7.0.3
-  resolution: "cross-spawn@npm:7.0.3"
+  version: 7.0.6
+  resolution: "cross-spawn@npm:7.0.6"
   dependencies:
     path-key: ^3.1.0
     shebang-command: ^2.0.0
     which: ^2.0.1
-  checksum: 671cc7c7288c3a8406f3c69a3ae2fc85555c04169e9d611def9a675635472614f1c0ed0ef80955d5b6d4e724f6ced67f0ad1bb006c2ea643488fcfef994d7f52
+  checksum: 8d306efacaf6f3f60e0224c287664093fa9185680b2d195852ba9a863f85d02dcc737094c6e512175f8ee0161f9b87c73c6826034c2422e39de7d6569cf4503b
   languageName: node
   linkType: hard
 
-"csv-parse@npm:^5.5.6":
-  version: 5.5.6
-  resolution: "csv-parse@npm:5.5.6"
-  checksum: ee06f97f674487dc1d001b360de8ea510a41b9d971abf43bcf9c3be22c83a3634df0d3ebfbe52fd49d145077066be7ff9f25de3fc6b71aefb973099b04147a25
+"csv-parse@npm:^5.6.0":
+  version: 5.6.0
+  resolution: "csv-parse@npm:5.6.0"
+  checksum: 173e176bdaf212bab37d0f6d39a06d039d24a1c0ee40b9f1023ebf8b36095934807deeb493c0fb58592b39b0682ccd0be5c9e8d2b137c08807e7031595ea7a51
   languageName: node
   linkType: hard
 
@@ -3360,7 +3359,7 @@ __metadata:
   resolution: "docker-setup-docker@workspace:."
   dependencies:
     "@actions/core": ^1.11.1
-    "@docker/actions-toolkit": ^0.40.0
+    "@docker/actions-toolkit": ^0.46.0
     "@types/node": ^20.6.0
     "@typescript-eslint/eslint-plugin": ^6.6.0
     "@typescript-eslint/parser": ^6.6.0
@@ -7106,7 +7105,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"uuid@npm:^3.3.2, uuid@npm:^3.3.3":
+"uuid@npm:^3.3.2":
   version: 3.4.0
   resolution: "uuid@npm:3.4.0"
   bin: