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

readme: remove qemu set up workaround

.dockerignore

@@ -1,2 +1,12 @@
 /coverage
-/node_modules
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.eslintignore

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

.eslintrc.json

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

.gitattributes

@@ -1,2 +1,4 @@
+/.yarn/releases/** binary
+/.yarn/plugins/** binary
 /dist/** linguist-generated=true
 /lib/** linguist-generated=true

.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,8 +17,7 @@ on:
   pull_request:
 
 env:
-  DOCKER_VERSION: v23.0.6
-  SIGN_QEMU_BINARY: 1
+  DOCKER_VERSION: v27.3.1
 
 jobs:
   main:
@@ -24,31 +27,21 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          - macos-latest
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+          - macos-13
           - windows-latest
         version:
-          - pinned
-          - latest
+          - v27.3.1
+          - type=image,tag=27.3.1
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
-      -
-        name: Set version
-        shell: bash
-        run: |
-          if [ "${{ matrix.version }}" != "pinned" ]; then
-            echo "DOCKER_VERSION=${{ matrix.version }}" >> $GITHUB_ENV
-          fi
+        uses: actions/checkout@v4
       -
         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 }}
@@ -57,22 +50,19 @@ 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@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker
         uses: ./
         with:
-          version: v23.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 }}
@@ -81,16 +71,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@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker
         uses: ./
         with:
+          version: ${{ env.DOCKER_VERSION }}
           daemon-config: |
             {
               "debug": true,
@@ -98,10 +90,6 @@ jobs:
                 "containerd-snapshotter": true
               }
             }
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   context:
     runs-on: ${{ matrix.os }}
@@ -110,12 +98,13 @@ 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@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker
         uses: ./
@@ -126,17 +115,39 @@ jobs:
         name: Check context
         run: |
           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
+    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 }}
+        env:
+          LIMA_START_ARGS: --cpus 4 --memory 8
 
   build-linux:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        containerd:
+          - containerd-system
+          - containerd-tarball
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        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: ./
@@ -148,13 +159,13 @@ jobs:
           docker run -d -p 5000:5000 --restart=always --name registry registry:2
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           driver: docker
           driver-opts: network=host
       -
         name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           context: ./test
           push: true
@@ -164,17 +175,19 @@ 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: macos-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          #- macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
+          - macos-13
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker
         uses: ./
@@ -186,13 +199,13 @@ jobs:
           docker run -d -p 5000:5000 --restart=always --name registry registry:2
       -
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           driver: docker
           driver-opts: network=host
       -
         name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           context: ./test
           push: true
@@ -202,17 +215,13 @@ 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
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Set up Docker
         uses: ./
@@ -227,7 +236,37 @@ jobs:
         name: Inspect
         run: |
           docker image inspect test
+
+  set-host:
+    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 }}
+          set-host: true
+      -
+        name: List contexts
+        run: |
+          docker context ls
+
+  rootless:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        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

@@ -1,5 +1,9 @@
 name: test
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
@@ -13,14 +17,15 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Test
-        uses: docker/bake-action@v3
+        uses: docker/bake-action@v5
         with:
           targets: test
       -
         name: Upload coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
-          file: ./coverage/clover.xml
+          files: ./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:
@@ -15,7 +19,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Targets matrix
         id: targets
@@ -33,9 +37,9 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       -
         name: Validate
-        uses: docker/bake-action@v3
+        uses: docker/bake-action@v5
         with:
           targets: ${{ matrix.target }}

.gitignore

@@ -1,7 +1,5 @@
-node_modules
-lib
+# https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
 
-# Rest of the file pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
 logs
 *.log
@@ -9,6 +7,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -19,34 +18,14 @@ pids
 *.seed
 *.pid.lock
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
 # Coverage directory used by tools like istanbul
 coverage
 *.lcov
 
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
+node_modules/
 jspm_packages/
 
-# TypeScript v1 declaration files
-typings/
-
 # TypeScript cache
 *.tsbuildinfo
 
@@ -56,36 +35,19 @@ typings/
 # Optional eslint cache
 .eslintcache
 
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
+# dotenv environment variable files
 .env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# next.js build output
-.next
-
-# nuxt.js build output
-.nuxt
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.prettierignore

@@ -0,0 +1,6 @@
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# yarn v2
+.yarn/

.yarnrc.yml

@@ -0,0 +1,13 @@
+logFilters:
+  - code: YN0013
+    level: discard
+  - code: YN0019
+    level: discard
+  - code: YN0076
+    level: discard
+
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"

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)
 
 ___
@@ -16,9 +21,10 @@ ___
 * [Usage](#usage)
   * [Quick start](#quick-start)
   * [Daemon configuration](#daemon-configuration)
+  * [Define custom `limactl start` arguments (macOS)](#define-custom-limactl-start-arguments-macos)
 * [Customizing](#customizing)
   * [inputs](#inputs)
-* [Notes](#notes)
+  * [outputs](#outputs)
 * [Contributing](#contributing)
 * [License](#license)
 
@@ -38,7 +44,7 @@ jobs:
     steps:
       -
         name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v1
+        uses: crazy-max/ghaction-setup-docker@v3
 ```
 
 ### Daemon configuration
@@ -60,7 +66,7 @@ jobs:
     steps:
       -
         name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v1
+        uses: crazy-max/ghaction-setup-docker@v3
         with:
           daemon-config: |
             {
@@ -71,83 +77,55 @@ jobs:
             }
 ```
 
+### Define custom `limactl start` arguments (macOS)
+
+You can define custom [`limactl start` arguments](https://lima-vm.io/docs/reference/limactl_start/)
+using the `LIMA_START_ARGS` environment variable to customize the VM:
+
+```yaml
+name: ci
+
+on:
+  push:
+
+jobs:
+  docker:
+    runs-on: macos-latest
+    steps:
+      -
+        name: Set up Docker
+        uses: crazy-max/ghaction-setup-docker@v3
+        env:
+          LIMA_START_ARGS: --cpus 4 --memory 8
+```
+
 ## Customizing
 
 ### inputs
 
-Following inputs can be used as `step.with` keys
+The following inputs can be used as `step.with` keys
 
 | Name            | Type   | Default               | Description                                                                                                                 |
 |-----------------|--------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
-| `version`       | String | `latest`              | Docker CE version (e.g., `v23.0.1`).                                                                                        |
+| `version`       | String | `latest`              | Docker CE version (e.g., `v24.0.6`).                                                                                        |
 | `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.                                                               |
+| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |
 
-## Notes
+### outputs
 
-### macOS: `qemu[stderr]: qemu-system-x86_64: Unknown Error`
+The following outputs are available
 
-Colima may fail to start with the following error:
-
-```
-time="2023-08-26T06:30:33Z" level=info msg="[hostagent] Starting QEMU (hint: to watch the boot progress, see \"/Users/runner/.lima/colima/serial*.log\")"
-time="2023-08-26T06:30:34Z" level=info msg="SSH Local Port: 49209"
-time="2023-08-26T06:30:34Z" level=info msg="[hostagent] Waiting for the essential requirement 1 of 3: \"ssh\""
-time="2023-08-26T06:30:34Z" level=info msg="[hostagent] Driver stopped due to error: \"exit status 255\""
-time="2023-08-26T06:30:34Z" level=info msg="[hostagent] Shutting down the host agent"
-time="2023-08-26T06:30:34Z" level=warning msg="[hostagent] failed to exit SSH master"
-time="2023-08-26T06:30:34Z" level=info msg="[hostagent] Shutting down QEMU with ACPI"
-time="2023-08-26T06:30:34Z" level=warning msg="[hostagent] failed to open the QMP socket \"/Users/runner/.lima/colima/qmp.sock\", forcibly killing QEMU"
-time="2023-08-26T06:30:34Z" level=info msg="[hostagent] QEMU has already exited"
-time="2023-08-26T06:30:34Z" level=fatal msg="exiting, status={Running:false Degraded:false Exiting:true Errors:[] SSHLocalPort:0} (hint: see \"/Users/runner/.lima/colima/ha.stderr.log\")"
-time="2023-08-26T06:30:34Z" level=fatal msg="error starting vm: error at 'creating and starting': exit status 1"
-```
-
-```
-{"level":"debug","msg":"executing [ssh-keygen -t ed25519 -q -N  -f /Users/runner/.lima/_config/user]","time":"2023-08-26T07:16:40Z"}
-{"level":"debug","msg":"Creating iso file /Users/runner/.lima/colima/cidata.iso","time":"2023-08-26T07:16:41Z"}
-{"level":"debug","msg":"Using /var/folders/24/8k48jl6d249_n_qfxwsl6xvm0000gn/T/diskfs_iso3418167253 as workspace","time":"2023-08-26T07:16:41Z"}
-{"level":"debug","msg":"OpenSSH version 8.6.1 detected","time":"2023-08-26T07:16:41Z"}
-{"level":"debug","msg":"AES accelerator seems available, prioritizing aes128-gcm@openssh.com and aes256-gcm@openssh.com","time":"2023-08-26T07:16:41Z"}
-{"level":"debug","msg":"QEMU version 8.0.4 detected","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"firmware candidates = [/Users/runner/.local/share/qemu/edk2-x86_64-code.fd /Users/runner/.colima/_wrapper/4e1b408f843d1c63afbbdcf80c40e4c88d33509f/share/qemu/edk2-x86_64-code.fd /usr/share/OVMF/OVMF_CODE.fd /usr/share/qemu/ovmf-x86_64-code.bin /usr/share/edk2-ovmf/x64/OVMF_CODE.fd]","time":"2023-08-26T07:16:43Z"}
-{"level":"info","msg":"Starting QEMU (hint: to watch the boot progress, see \"/Users/runner/.lima/colima/serial*.log\")","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"qCmd.Args: [/Users/runner/.colima/_wrapper/4e1b408f843d1c63afbbdcf80c40e4c88d33509f/bin/qemu-system-x86_64 -m 2048 -cpu host,-pdpe1gb -machine q35,accel=hvf -smp 2,sockets=1,cores=2,threads=1 -drive if=pflash,format=raw,readonly=on,file=/Users/runner/.colima/_wrapper/4e1b408f843d1c63afbbdcf80c40e4c88d33509f/share/qemu/edk2-x86_64-code.fd -boot order=d,splash-time=0,menu=on -drive file=/Users/runner/.lima/colima/basedisk,format=raw,media=cdrom,readonly=on -drive file=/Users/runner/.lima/colima/diffdisk,if=virtio,discard=on -drive id=cdrom0,if=none,format=raw,readonly=on,file=/Users/runner/.lima/colima/cidata.iso -device virtio-scsi-pci,id=scsi0 -device scsi-cd,bus=scsi0.0,drive=cdrom0 -netdev user,id=net0,net=192.168.5.0/24,dhcpstart=192.168.5.15,hostfwd=tcp:127.0.0.1:49168-:22 -device virtio-net-pci,netdev=net0,mac=52:55:55:be:6e:dd -device virtio-rng-pci -display none -device virtio-vga -device virtio-keyboard-pci -device virtio-mouse-pci -device qemu-xhci,id=usb-bus -parallel none -chardev socket,id=char-serial,path=/Users/runner/.lima/colima/serial.sock,server=on,wait=off,logfile=/Users/runner/.lima/colima/serial.log -serial chardev:char-serial -chardev socket,id=char-serial-virtio,path=/Users/runner/.lima/colima/serialv.sock,server=on,wait=off,logfile=/Users/runner/.lima/colima/serialv.log -device virtio-serial-pci,id=virtio-serial0,max_ports=1 -device virtconsole,chardev=char-serial-virtio,id=console0 -virtfs local,mount_tag=mount0,path=/Users/runner,security_model=none -virtfs local,mount_tag=mount1,path=/tmp/colima,security_model=none -chardev socket,id=char-qmp,path=/Users/runner/.lima/colima/qmp.sock,server=on,wait=off -qmp chardev:char-qmp -name lima-colima -pidfile /Users/runner/.lima/colima/qemu.pid]","time":"2023-08-26T07:16:43Z"}
-{"level":"info","msg":"Waiting for the essential requirement 1 of 3: \"ssh\"","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"executing script \"ssh\"","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"executing ssh for script \"ssh\": /usr/bin/ssh [ssh -F /dev/null -o IdentityFile=\"/Users/runner/.lima/_config/user\" -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o NoHostAuthenticationForLocalhost=yes -o GSSAPIAuthentication=no -o PreferredAuthentications=publickey -o Compression=no -o BatchMode=yes -o IdentitiesOnly=yes -o Ciphers=\"^aes128-gcm@openssh.com,aes256-gcm@openssh.com\" -o User=runner -o ControlMaster=auto -o ControlPath=\"/Users/runner/.lima/colima/ssh.sock\" -o ControlPersist=5m -p 49168 127.0.0.1 -- /bin/bash]","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"stdout=\"\", stderr=\"ssh: connect to host 127.0.0.1 port 49168: Connection refused\\r\\n\", err=failed to execute script \"ssh\": stdout=\"\", stderr=\"ssh: connect to host 127.0.0.1 port 49168: Connection refused\\r\\n\": exit status 255","time":"2023-08-26T07:16:43Z"}
-{"level":"debug","msg":"qemu[stderr]: qemu-system-x86_64: Unknown Error","time":"2023-08-26T07:16:43Z"}
-{"level":"info","msg":"Driver stopped due to error: \"exit status 255\"","time":"2023-08-26T07:16:43Z"}
-{"level":"info","msg":"Shutting down the host agent","time":"2023-08-26T07:16:44Z"}
-{"level":"debug","msg":"shutting down the SSH master","time":"2023-08-26T07:16:44Z"}
-{"level":"debug","msg":"executing ssh for exiting the master: /usr/bin/ssh [ssh -F /dev/null -o IdentityFile=\"/Users/runner/.lima/_config/user\" -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o NoHostAuthenticationForLocalhost=yes -o GSSAPIAuthentication=no -o PreferredAuthentications=publickey -o Compression=no -o BatchMode=yes -o IdentitiesOnly=yes -o Ciphers=\"^aes128-gcm@openssh.com,aes256-gcm@openssh.com\" -o User=runner -o ControlMaster=auto -o ControlPath=\"/Users/runner/.lima/colima/ssh.sock\" -o ControlPersist=5m -O exit -p 49168 127.0.0.1]","time":"2023-08-26T07:16:44Z"}
-{"error":"failed to execute `ssh -O exit -p 49168 127.0.0.1`, out=\"Control socket connect(/Users/runner/.lima/colima/ssh.sock): No such file or directory\\r\\n\": exit status 255","level":"warning","msg":"failed to exit SSH master","time":"2023-08-26T07:16:44Z"}
-{"level":"info","msg":"Shutting down QEMU with ACPI","time":"2023-08-26T07:16:44Z"}
-{"error":"dial unix /Users/runner/.lima/colima/qmp.sock: connect: connection refused","level":"warning","msg":"failed to open the QMP socket \"/Users/runner/.lima/colima/qmp.sock\", forcibly killing QEMU","time":"2023-08-26T07:16:44Z"}
-{"level":"info","msg":"QEMU has already exited","time":"2023-08-26T07:16:44Z"}
-```
-
-To fix this issue you can replace the existing signature of QEMU binary with
-the required entitlements as suggested in https://github.com/abiosoft/colima/issues/786#issuecomment-1693629650.
-This can be done within this action by setting the env var `SIGN_QEMU_BINARY=1`:
-
-```yaml
-      -
-        name: Set up Docker
-        uses: crazy-max/ghaction-setup-docker@v1
-        env:
-          SIGN_QEMU_BINARY: 1
-```
+| Name   | Type   | Description        |
+|--------|--------|--------------------|
+| `sock` | String | Docker socket path |
 
 ## Contributing
 
 Want to contribute? Awesome! The most basic way to show your support is to star
-the project, or to raise issues. If you want to open a pull request, please
-read the [contributing guidelines](.github/CONTRIBUTING.md).
-
-You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)
+the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)
 or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
 journey continues indefinitely!
 

__tests__/context.test.ts

@@ -17,40 +17,174 @@ describe('getInputs', () => {
     [
       0,
       new Map<string, string>([
-        ['version', 'v23.0.1'],
+        ['version', 'v24.0.8'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v23.0.1',
-        channel: '',
+        source: {
+          type: 'archive',
+          version: 'v24.0.8',
+          channel: 'stable'
+        },
         context: '',
         daemonConfig: '',
+        rootless: false,
+        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'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v23.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
     ],
     [
       2,
-      new Map<string, string>([]),
+      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

@@ -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,8 +20,20 @@ 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
+  rootless:
+    description: 'Enable Docker rootless mode'
+    default: 'false'
+    required: false
+
+outputs:
+  sock:
+    description: "Docker socket path"
 
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'
   post: 'dist/index.js'

codecov.yml

@@ -1,3 +1,12 @@
 comment: false
+
+coverage:
+  status:
+    project:  # settings affecting project coverage
+      default:
+        target: auto  # auto % coverage target
+        threshold: 5%  # allow for 5% reduction of coverage without failing
+    patch: off
+
 github_checks:
   annotations: false

dev.Dockerfile

@@ -1,13 +1,20 @@
 # syntax=docker/dockerfile:1
 
-ARG NODE_VERSION=16
+ARG NODE_VERSION=20
 
 FROM node:${NODE_VERSION}-alpine AS base
 RUN apk add --no-cache cpio findutils git
 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 \
+  --mount=type=cache,target=/src/.yarn/cache \
   --mount=type=cache,target=/src/node_modules \
   yarn install && mkdir /vendor && cp yarn.lock /vendor
 
@@ -28,6 +35,7 @@ EOT
 
 FROM deps AS build
 RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/.yarn/cache \
   --mount=type=cache,target=/src/node_modules \
   yarn run build && mkdir /out && cp -Rf dist /out/
 
@@ -48,6 +56,7 @@ EOT
 
 FROM deps AS format
 RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/.yarn/cache \
   --mount=type=cache,target=/src/node_modules \
   yarn run format \
   && mkdir /out && find . -name '*.ts' -not -path './node_modules/*' | cpio -pdm /out
@@ -57,13 +66,15 @@ COPY --from=format /out /
 
 FROM deps AS lint
 RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/.yarn/cache \
   --mount=type=cache,target=/src/node_modules \
   yarn run lint
 
 FROM deps AS test
 RUN --mount=type=bind,target=.,rw \
+  --mount=type=cache,target=/src/.yarn/cache \
   --mount=type=cache,target=/src/node_modules \
-  yarn run test --coverageDirectory=/tmp/coverage
+  yarn run test --coverage --coverageDirectory=/tmp/coverage
 
 FROM scratch AS test-coverage
 COPY --from=test /tmp/coverage /

jest.config.ts

@@ -15,6 +15,7 @@ process.env = Object.assign({}, process.env, {
 
 module.exports = {
   clearMocks: true,
+  testEnvironment: 'node',
   moduleFileExtensions: ['js', 'ts'],
   testMatch: ['**/*.test.ts'],
   transform: {

package.json

@@ -4,9 +4,13 @@
   "main": "lib/main.js",
   "scripts": {
     "build": "ncc build src/main.ts --source-map --minify --license licenses.txt",
-    "lint": "eslint src/**/*.ts __tests__/**/*.ts",
-    "format": "eslint --fix src/**/*.ts __tests__/**/*.ts",
-    "test": "jest --coverage",
+    "lint": "yarn run prettier && yarn run eslint",
+    "format": "yarn run prettier:fix && yarn run eslint:fix",
+    "eslint": "eslint --max-warnings=0 .",
+    "eslint:fix": "eslint --fix .",
+    "prettier": "prettier --check \"./**/*.ts\"",
+    "prettier:fix": "prettier --write \"./**/*.ts\"",
+    "test": "jest",
     "all": "yarn run build && yarn run format && yarn test"
   },
   "repository": {
@@ -20,24 +24,24 @@
   ],
   "author": "CrazyMax",
   "license": "Apache-2.0",
+  "packageManager": "yarn@3.6.3",
   "dependencies": {
-    "@actions/core": "^1.10.0",
-    "@docker/actions-toolkit": "^0.11.0",
-    "uuid": "^9.0.0"
+    "@actions/core": "^1.11.1",
+    "@docker/actions-toolkit": "^0.46.0"
   },
   "devDependencies": {
-    "@types/node": "^16.11.26",
-    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "@typescript-eslint/parser": "^5.14.0",
-    "@vercel/ncc": "^0.33.3",
-    "eslint": "^8.11.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.5",
-    "prettier": "^2.3.1",
-    "ts-jest": "^27.1.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.4.4"
+    "@types/node": "^20.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "@vercel/ncc": "^0.38.0",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.6.4",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   }
 }

src/context.ts

@@ -1,17 +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')
+    context: core.getInput('context'),
+    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

@@ -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.`);
@@ -21,20 +21,31 @@ 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();
       });
     }
     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 () => {

tsconfig.json

@@ -3,7 +3,6 @@
     "esModuleInterop": true,
     "target": "es6",
     "module": "commonjs",
-    "strict": true,
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
@@ -13,9 +12,8 @@
     "useUnknownInCatchVariables": false,
   },
   "exclude": [
-    "./__tests__/**/*",
-    "./lib/**/*",
     "node_modules",
+    "**/*.test.ts",
     "jest.config.ts"
   ]
 }