Merge pull request #215 from crazy-max/node24

node 24 as default runtime

.eslintignore

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

.eslintrc.json

@@ -1,24 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es6": true,
-    "jest": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/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/workflows/update-dist.yml

@@ -0,0 +1,49 @@
+name: update-dist
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  update-dist:
+    if: github.actor == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: GitHub auth token from GitHub App
+        id: docker-read-app
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ secrets.GHACTIONS_REPO_WRITE_APP_ID }}
+          private-key: ${{ secrets.GHACTIONS_REPO_WRITE_APP_PRIVATE_KEY }}
+          owner: docker
+      -
+        name: Checkout
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+          token: ${{ steps.docker-read-app.outputs.token || github.token }}
+      -
+        name: Build
+        uses: docker/bake-action@v6
+        with:
+          source: .
+          targets: build
+      -
+        name: Commit and push dist
+        run: |
+          if [ -n "$(git status --porcelain -- dist)" ]; then
+            (
+              set -x
+              git config user.name "github-actions[bot]"
+              git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+              git add dist
+              git commit -m "chore: update generated content"
+              git push
+            )
+          else
+            echo "No changes in dist"
+          fi

.prettierrc.json

@@ -6,6 +6,5 @@
   "singleQuote": true,
   "trailingComma": "none",
   "bracketSpacing": false,
-  "arrowParens": "avoid",
+  "arrowParens": "avoid"
-  "parser": "typescript"
 }

.yarnrc.yml

@@ -1,3 +1,9 @@
+# https://yarnpkg.com/configuration/yarnrc
+
+compressionLevel: mixed
+enableGlobalCache: false
+enableHardenedMode: true
+
 logFilters:
   - code: YN0013
     level: discard
@@ -5,9 +11,7 @@ logFilters:
     level: discard
   - code: YN0076
     level: discard
+  - code: YN0086
+    level: discard
 
 nodeLinker: node-modules
-
-plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"

README.md

@@ -114,7 +114,7 @@ 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)                                  |
@@ -123,6 +123,7 @@ The following inputs can be used as `step.with` keys
 | `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,8 +1,8 @@
-import {beforeEach, describe, expect, test} from '@jest/globals';
+import {beforeEach, describe, expect, test} from 'vitest';
 import * as os from 'os';
 import * as path from 'path';
 
-import * as context from '../src/context';
+import * as context from '../src/context.js';
 
 describe('getInputs', () => {
   beforeEach(() => {
@@ -15,7 +15,7 @@ describe('getInputs', () => {
   });
 
   // prettier-ignore
-  test.each([
+  const cases: [number, Map<string, string>, context.Inputs][] = [
     [
       0,
       new Map<string, string>([
@@ -35,7 +35,7 @@ describe('getInputs', () => {
         setHost: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       1,
@@ -59,7 +59,7 @@ describe('getInputs', () => {
         setHost: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       2,
@@ -79,7 +79,7 @@ describe('getInputs', () => {
         setHost: true,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
     3,
@@ -101,7 +101,7 @@ describe('getInputs', () => {
         setHost: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       4,
@@ -121,7 +121,7 @@ describe('getInputs', () => {
         setHost: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       5,
@@ -142,7 +142,7 @@ describe('getInputs', () => {
         rootless: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       6,
@@ -163,7 +163,7 @@ describe('getInputs', () => {
         rootless: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       7,
@@ -183,7 +183,7 @@ describe('getInputs', () => {
         rootless: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       8,
@@ -203,7 +203,7 @@ describe('getInputs', () => {
         rootless: true,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
     [
       9,
@@ -226,10 +226,11 @@ describe('getInputs', () => {
         setHost: false,
         runtimeBasedir: path.join(os.homedir(), `setup-docker-action`),
         githubToken: '',
-      } as context.Inputs
+      }
     ],
-  ])(
+  ];
-    '[%d] given %p as inputs, returns %p',
+  test.each(cases)(
+    '[%d] given %o as inputs, returns %o',
     async (num: number, inputs: Map<string, string>, expected: context.Inputs) => {
       inputs.forEach((value: string, name: string) => {
         setInput(name, value);

__tests__/setup.unit.ts

@@ -0,0 +1,12 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-docker-action-'));
+
+process.env = Object.assign({}, process.env, {
+  TEMP: tmpDir,
+  GITHUB_REPOSITORY: 'docker/setup-docker-action',
+  RUNNER_TEMP: path.join(tmpDir, 'runner-temp'),
+  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache')
+});

action.yml

@@ -46,6 +46,6 @@ outputs:
     description: "Docker TCP address if tcp-port is set"
 
 runs:
-  using: 'node20'
+  using: 'node24'
   main: 'dist/index.js'
   post: 'dist/index.js'

dev.Dockerfile

@@ -1,12 +1,13 @@
 # syntax=docker/dockerfile:1
 
-ARG NODE_VERSION=20
+ARG NODE_VERSION=24
 
 FROM node:${NODE_VERSION}-alpine AS base
-RUN apk add --no-cache cpio findutils git
+RUN apk add --no-cache cpio findutils git rsync
 WORKDIR /src
 RUN --mount=type=bind,target=.,rw \
   --mount=type=cache,target=/src/.yarn/cache <<EOT
+  set -e
   corepack enable
   yarn --version
   yarn config set --home enableTelemetry 0
@@ -27,25 +28,34 @@ RUN --mount=type=bind,target=.,rw <<EOT
   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"'
+    echo >&2 'ERROR: Vendor result differs. Please vendor your package with "docker buildx bake vendor"'
     git status --porcelain -- yarn.lock
     exit 1
   fi
 EOT
 
 FROM deps AS build
-RUN --mount=type=bind,target=.,rw \
+RUN --mount=target=/context \
   --mount=type=cache,target=/src/.yarn/cache \
-  --mount=type=cache,target=/src/node_modules \
+  --mount=type=cache,target=/src/node_modules <<EOT
-  yarn run build && mkdir /out && cp -Rf dist /out/
+  set -e
+  rsync -a /context/. .
+  rm -rf dist
+  yarn run build
+  mkdir /out
+  cp -r dist /out
+EOT
 
 FROM scratch AS build-update
 COPY --from=build /out /
 
 FROM build AS build-validate
-RUN --mount=type=bind,target=.,rw <<EOT
+RUN --mount=target=/context \
+  --mount=target=.,type=tmpfs <<EOT
   set -e
+  rsync -a /context/. .
   git add -A
+  rm -rf dist
   cp -rf /out/* .
   if [ -n "$(git status --porcelain -- dist)" ]; then
     echo >&2 'ERROR: Build result differs. Please build first with "docker buildx bake build"'
@@ -58,8 +68,7 @@ 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 \
+  yarn run format && mkdir /out && find . -name '*.ts' -not -path './node_modules/*' -not -path './.yarn/*' | cpio -pdm /out
-  && mkdir /out && find . -name '*.ts' -not -path './node_modules/*' | cpio -pdm /out
 
 FROM scratch AS format-update
 COPY --from=format /out /
@@ -74,7 +83,7 @@ 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 --coverage --coverageDirectory=/tmp/coverage
+  yarn run test --coverage --coverage.reportsDirectory=/tmp/coverage
 
 FROM scratch AS test-coverage
 COPY --from=test /tmp/coverage /

dist/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

eslint.config.mjs

@@ -0,0 +1,52 @@
+import {defineConfig} from 'eslint/config';
+import js from '@eslint/js';
+import tseslint from '@typescript-eslint/eslint-plugin';
+import vitest from '@vitest/eslint-plugin';
+import globals from 'globals';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+import eslintPluginPrettier from 'eslint-plugin-prettier';
+
+export default defineConfig([
+  {
+    ignores: ['.yarn/**/*', 'coverage/**/*', 'dist/**/*']
+  },
+  js.configs.recommended,
+  ...tseslint.configs['flat/recommended'],
+  eslintConfigPrettier,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  },
+  {
+    files: ['__tests__/**'],
+    ...vitest.configs.recommended,
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...vitest.environments.env.globals
+      }
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+      'vitest/no-conditional-expect': 'error',
+      'vitest/no-disabled-tests': 0
+    }
+  },
+  {
+    plugins: {
+      prettier: eslintPluginPrettier
+    },
+    rules: {
+      'prettier/prettier': 'error',
+      '@typescript-eslint/no-require-imports': [
+        'error',
+        {
+          allowAsImport: true
+        }
+      ]
+    }
+  }
+]);

jest.config.ts

@@ -1,30 +0,0 @@
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
-
-const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-setup-docker-action-'));
-
-process.env = Object.assign({}, process.env, {
-  TEMP: tmpDir,
-  GITHUB_REPOSITORY: 'docker/setup-docker-action',
-  RUNNER_TEMP: path.join(tmpDir, 'runner-temp'),
-  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache')
-}) as {
-  [key: string]: string;
-};
-
-module.exports = {
-  clearMocks: true,
-  testEnvironment: 'node',
-  moduleFileExtensions: ['js', 'ts'],
-  testMatch: ['**/*.test.ts'],
-  transform: {
-    '^.+\\.ts$': 'ts-jest'
-  },
-  moduleNameMapper: {
-    '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
-  },
-  collectCoverageFrom: ['src/**/{!(main.ts),}.ts'],
-  coveragePathIgnorePatterns: ['lib/', 'node_modules/', '__mocks__/', '__tests__/'],
-  verbose: true
-};

package.json

@@ -1,16 +1,13 @@
 {
   "name": "docker-setup-docker",
   "description": "Set up Docker for use in GitHub Actions by downloading and installing a version of Docker CE",
-  "main": "lib/main.js",
+  "type": "module",
+  "main": "src/main.ts",
   "scripts": {
     "build": "ncc build src/main.ts --source-map --minify --license licenses.txt",
-    "lint": "yarn run prettier && yarn run eslint",
+    "lint": "eslint --max-warnings=0 .",
-    "format": "yarn run prettier:fix && yarn run eslint:fix",
+    "format": "eslint --fix .",
-    "eslint": "eslint --max-warnings=0 .",
+    "test": "vitest run",
-    "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": {
@@ -24,24 +21,25 @@
   ],
   "author": "Docker Inc.",
   "license": "Apache-2.0",
-  "packageManager": "yarn@3.6.3",
+  "packageManager": "yarn@4.9.2",
   "dependencies": {
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^3.0.0",
-    "@docker/actions-toolkit": "^0.68.0"
+    "@docker/actions-toolkit": "^0.77.0"
   },
   "devDependencies": {
-    "@types/node": "^20.6.0",
+    "@eslint/js": "^9.39.3",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@types/node": "^24.11.0",
-    "@typescript-eslint/parser": "^6.6.0",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@vercel/ncc": "^0.38.0",
+    "@typescript-eslint/parser": "^8.56.1",
-    "eslint": "^8.49.0",
+    "@vercel/ncc": "^0.38.4",
-    "eslint-config-prettier": "^9.0.0",
+    "@vitest/coverage-v8": "^4.0.18",
-    "eslint-plugin-jest": "^27.2.3",
+    "@vitest/eslint-plugin": "^1.6.9",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint": "^9.39.3",
-    "jest": "^29.6.4",
+    "eslint-config-prettier": "^10.1.8",
-    "prettier": "^3.0.3",
+    "eslint-plugin-prettier": "^5.5.5",
-    "ts-jest": "^29.1.1",
+    "globals": "^17.3.0",
-    "ts-node": "^10.9.1",
+    "prettier": "^3.8.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   }
 }

src/context.ts

@@ -3,8 +3,8 @@ import path from 'path';
 import * as core from '@actions/core';
 import {parse} from 'csv-parse/sync';
 
-import {InstallSource} from '@docker/actions-toolkit/lib/docker/install';
+import {InstallSource} from '@docker/actions-toolkit/lib/docker/install.js';
-import {Util} from '@docker/actions-toolkit/lib/util';
+import {Util} from '@docker/actions-toolkit/lib/util.js';
 
 export interface Inputs {
   source: InstallSource;

src/main.ts

@@ -2,13 +2,13 @@ import * as crypto from 'crypto';
 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 {Install} from '@docker/actions-toolkit/lib/docker/install.js';
-import {Docker} from '@docker/actions-toolkit/lib/docker/docker';
+import {Docker} from '@docker/actions-toolkit/lib/docker/docker.js';
-import {Install as RegclientInstall} from '@docker/actions-toolkit/lib/regclient/install';
+import {Install as RegclientInstall} from '@docker/actions-toolkit/lib/regclient/install.js';
-import {Install as UndockInstall} from '@docker/actions-toolkit/lib/undock/install';
+import {Install as UndockInstall} from '@docker/actions-toolkit/lib/undock/install.js';
 
-import * as context from './context';
+import * as context from './context.js';
-import * as stateHelper from './state-helper';
+import * as stateHelper from './state-helper.js';
 
 const regctlDefaultVersion = 'v0.8.3';
 const undockDefaultVersion = 'v0.10.0';

tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "esModuleInterop": true,
-    "target": "es6",
-    "module": "commonjs",
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
@@ -11,9 +11,7 @@
     "resolveJsonModule": true,
     "useUnknownInCatchVariables": false,
   },
-  "exclude": [
+  "include": [
-    "node_modules",
+    "src/**/*.ts"
-    "**/*.test.ts",
-    "jest.config.ts"
   ]
 }

vitest.config.ts

@@ -0,0 +1,16 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    clearMocks: true,
+    environment: 'node',
+    setupFiles: ['./__tests__/setup.unit.ts'],
+    include: ['**/*.test.ts'],
+    coverage: {
+      provider: 'v8',
+      reporter: ['clover'],
+      include: ['src/**/*.ts'],
+      exclude: ['src/**/main.ts']
+    }
+  }
+});