fix: 误删除

## [1.2.2](https://github.com/KengoTODA/actions-setup-docker-compose/compare/v1.2.1...v1.2.2) (2024-04-07)

### Bug Fixes

* **deps:** update dependency @octokit/action to v6.1.0 ([d6b647d](d6b647df28))

.eslintrc.json

@@ -11,6 +11,7 @@
       "eslint-comments/no-use": "off",
       "import/no-namespace": "off",
       "no-unused-vars": "off",
+      "i18n-text/no-en": "off",
       "@typescript-eslint/no-unused-vars": "error",
       "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
       "@typescript-eslint/no-require-imports": "error",

.github/FUNDING.yml

@@ -1 +0,0 @@
-github: [KengoTODA]

.github/auto-merge.yml

@@ -1,6 +0,0 @@
-minApprovals:
-  NONE: 0
-requiredLabels:
-  - dependencies
-updateBranch: true
-mergeMethod: rebase

.github/dependabot.yml

@@ -1,10 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    directory: "/"
-    schedule:
-      interval: daily
-    commit-message:
-      prefix: fix
-      prefix-development: chore
-      include: scope

.github/workflows/test.yml

@@ -1,39 +0,0 @@
-name: 'build-test'
-on: # rebuild any PRs and main branch changes
-  pull_request:
-  push:
-    branches:
-      - main
-      - 'releases/*'
-
-jobs:
-  build: # make sure build/ci work properly
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          # Make sure the release step uses its own credentials.
-          persist-credentials: false
-      - name: Read .nvmrc
-        run: echo ::set-output name=NVMRC::$(cat .nvmrc)
-        id: nvm
-      - uses: actions/setup-node@v2
-        with:
-          cache: npm
-          node-version: ${{ steps.nvm.outputs.NVMRC }}
-      - run: |
-          npm ci
-          npm run all
-      - name: Run semantic-release
-        run: |
-          npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT_TO_PUSH }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-  test: # make sure the action works on a clean machine without building
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ./
-        with:
-          version: '1.26.2'

.nvmrc

@@ -1 +1 @@
-12
+20

LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License (MIT)
 
-Copyright (c) 2018 GitHub, Inc. and contributors
+Copyright (c) 2021-2024 Kengo TODA
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,15 +4,29 @@
 
 This action downloads the `docker-compose` command and add it to the `PATH` for following executions. It supports the Linux environment only.
 
+> [!IMPORTANT]
+> The `docker-compose` command is now deprecated, consider to use the `docker compose` sub command instead. Refer to [Docker official blog](https://www.docker.com/blog/announcing-compose-v2-general-availability/) for detail.
+
 ## How to use
 
 Add a step to your workflow like below:
 
 ```yml
   steps:
-  - uses: KengoTODA/actions-setup-docker-compose@main
+  - uses: KengoTODA/actions-setup-docker-compose@v1
     with:
-      version: '1.26.2'
+      version: '2.14.2' # the full version of `docker-compose` command
 ```
 
-The `version` parameter is required, specify the full version of `docker-compose` command.
+Or set a `GITHUB_TOKEN` environment variable, to use the latest released version:
+
+```yml
+  steps:
+  - uses: KengoTODA/actions-setup-docker-compose@main
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+The 'latest release' here means [the most recent non-prerelease, non-draft release, sorted by the created_at attribute](https://octokit.github.io/rest.js/v19#repos-get-latest-release).
+
+Note that the `GITHUB_TOKEN` should have [`contents: read` permission](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents) to fetch data from the GitHub.com.

__tests__/install.test.ts

@@ -1,7 +1,27 @@
-import {runCommand} from '../src/install'
-import {expect, test} from '@jest/globals'
+import {install, runCommand} from '../src/install'
+import * as core from '@actions/core'
 
-test('runCommand', async () => {
-  const result = await runCommand('echo foo bar')
-  expect(result).toBe('foo bar')
+import {describe, expect, it, test} from '@jest/globals'
+
+describe('runCommand', () => {
+  it('runs a command and returns its stdout', async () => {
+    const result = await runCommand('echo foo bar')
+    expect(result).toBe('foo bar')
+  })
+})
+
+describe('install', () => {
+  const cases = ['1.29.1', '1.29.2', '2.2.3', 'v2.2.3', 'v2.10.2']
+  test.each(cases)('can install version %p', async (version: string) => {
+    const commandPath = await install(version)
+    core.addPath(commandPath)
+    const result = await runCommand('docker-compose version')
+    expect(result).toContain(version)
+  })
+  it('can install latest version', async () => {
+    const commandPath = await install('latest')
+    core.addPath(commandPath)
+    const result = await runCommand('docker-compose version')
+    expect(result).not.toBeFalsy()
+  })
 })

action.yml

@@ -3,8 +3,11 @@ description: 'Automate download and set up process for docker-compose command'
 author: 'Kengo TODA <skypencil@gmail.com>'
 inputs:
   version:
-    required: true
+    default: 'latest'
     description: 'the version of docker-compose command'
+branding:
+  color: blue
+  icon: play
 runs:
-  using: 'node12'
+  using: 'node20'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kengotoda/actions-setup-docker-compose",
-  "version": "1.0.0",
+  "version": "1.2.2",
   "description": "the GitHub Action setting up docker-compose command",
   "main": "lib/main.js",
   "private": false,
@@ -28,49 +28,25 @@
   "author": "Kengo TODA <skypencil@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.4.0",
-    "@actions/exec": "^1.1.0",
-    "@actions/tool-cache": "^1.7.1"
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.1",
+    "@actions/tool-cache": "^2.0.1",
+    "@octokit/action": "^6.0.7"
   },
   "devDependencies": {
-    "@semantic-release/exec": "^5.0.0",
-    "@semantic-release/git": "^9.0.0",
-    "@types/node": "^16.3.2",
-    "@typescript-eslint/parser": "^4.28.3",
-    "@vercel/ncc": "^0.28.6",
-    "eslint": "^7.30.0",
-    "eslint-plugin-github": "^4.1.3",
-    "eslint-plugin-jest": "^24.3.6",
-    "jest": "^27.0.6",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vercel/ncc": "^0.38.0",
+    "eslint": "^8.1.0",
+    "eslint-plugin-github": "^4.10.2",
+    "eslint-plugin-jest": "^28.0.0",
+    "jest": "^29.0.0",
     "js-yaml": "^4.1.0",
-    "prettier": "2.3.2",
-    "semantic-release": "^17.4.4",
-    "ts-jest": "^27.0.3",
-    "typescript": "^4.3.5"
-  },
-  "release": {
-    "branches": "main",
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      [
-        "@semantic-release/exec",
-        {
-          "prepare": "npm run package"
-        }
-      ],
-      [
-        "@semantic-release/git",
-        {
-          "assets": [
-            "dist",
-            "package.json"
-          ],
-          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
+    "prettier": "3.3.3",
+    "semantic-release": "^24.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
   }
 }

renovate.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "packageRules": [
+    {
+      "matchDepTypes": ["devDependencies"],
+      "matchUpdateTypes": ["minor", "patch"],
+      "matchCurrentVersion": "!/^0/",
+      "automerge": true
+    }
+  ],
+  "extends": [
+    "config:recommended"
+  ]
+}

src/install.ts

@@ -1,5 +1,7 @@
+import {cacheFile, downloadTool} from '@actions/tool-cache'
 import {exec} from '@actions/exec'
-import {downloadTool} from '@actions/tool-cache'
+import * as core from '@actions/core'
+import {Octokit} from '@octokit/action'
 
 export async function runCommand(command: string): Promise<string> {
   let output = ''
@@ -19,13 +21,36 @@ export async function runCommand(command: string): Promise<string> {
 async function installOnLinux(version: string): Promise<string> {
   const system = runCommand('uname -s')
   const hardware = runCommand('uname -m')
-  const url = `https://github.com/docker/compose/releases/download/${version}/docker-compose-${await system}-${await hardware}`
+  if (!version.startsWith('v') && parseInt(version.split('.')[0], 10) >= 2) {
+    version = `v${version}`
+  }
+  const url = `https://gh.api.99988866.xyz/https://github.com/docker/compose/releases/download/${version}/docker-compose-${await system}-${await hardware}`
+  runCommand(`echo ${url}`)
   const installerPath = await downloadTool(url)
   await exec(`chmod +x ${installerPath}`)
-  return installerPath
+  const cachedPath = await cacheFile(
+    installerPath,
+    'docker-compose',
+    'docker-compose',
+    version
+  )
+  return cachedPath
+}
+
+async function findLatestVersion(): Promise<string> {
+  const octokit = new Octokit()
+  const response = await octokit.repos.getLatestRelease({
+    owner: 'docker',
+    repo: 'compose'
+  })
+  return response.data.tag_name
 }
 
 export async function install(version: string): Promise<string> {
+  if (version === 'latest') {
+    version = await findLatestVersion()
+    core.info(`Requested to use the latest version: ${version}`)
+  }
   switch (process.platform) {
     case 'linux':
       return installOnLinux(version)

src/main.ts

@@ -4,12 +4,12 @@ import {install} from './install'
 async function run(): Promise<void> {
   try {
     const version: string = core.getInput('version', {
-      required: true
+      trimWhitespace: true
     })
     const commandPath = await install(version)
     core.addPath(commandPath)
   } catch (error) {
-    core.setFailed(error.message)
+    core.setFailed(error instanceof Error ? error.message : 'Unknown error')
   }
 }
 

tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "lib": ["DOM", "ES2021"],
+    "target": "ES2021",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "outDir": "./lib",                        /* Redirect output structure to the directory. */
     "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */