chore(release): 1.1.1 [skip ci]

## [1.1.1](https://github.com/KengoTODA/actions-setup-docker-compose/compare/v1.1.0...v1.1.1) (2023-01-11)

### Bug Fixes

* **deps:** bump json5 from 1.0.1 to 1.0.2 ([90aa391](90aa3913e5))

.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/workflows/semantic-tag.yml

@@ -0,0 +1,45 @@
+name: Publish semantic tags
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      # Release with semantic tag like v1.0.3
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.release.tag_name }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - run: npm install semver
+      - name: Get versions
+        uses: actions/github-script@v6
+        id: batch
+        env:
+          TAG_NAME: ${{ github.event.release.tag_name }}
+        with:
+          script: |
+            const semver = require('semver')
+            const { TAG_NAME } = process.env
+            return {
+              minor: `v${semver.major(TAG_NAME).toString()}.${semver.minor(TAG_NAME).toString()}`,
+              major: `v${semver.major(TAG_NAME).toString()}`
+            }
+      - run: |
+          git tag -f "$MAJOR_VER"
+          git tag -f "$MINOR_VER"
+          git push origin -f "$MAJOR_VER"
+          git push origin -f "$MINOR_VER"
+        env:
+          MAJOR_VER: ${{ fromJSON(steps.batch.outputs.result).major }}
+          MINOR_VER: ${{ fromJSON(steps.batch.outputs.result).minor }}

.github/workflows/test.yml

@@ -10,20 +10,19 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         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
+      - uses: actions/setup-node@v3
         with:
           cache: npm
-          node-version: ${{ steps.nvm.outputs.NVMRC }}
+          node-version-file: '.nvmrc'
       - run: |
           npm ci
           npm run all
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Run semantic-release
         run: |
           npx semantic-release
@@ -32,8 +31,34 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./
         with:
           version: '1.26.2'
+      - uses: ./
+        with:
+          version: '2.4.1'
+      - uses: ./
+        with:
+          version: 'v2.4.1'
+      - uses: ./
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  actionlint:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request
+    permissions:
+      contents: read
+      checks: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: reviewdog/action-actionlint@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          reporter: github-pr-review

.nvmrc

@@ -1 +1 @@
-12
+16

LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License (MIT)
 
-Copyright (c) 2018 GitHub, Inc. and contributors
+Copyright (c) 2021 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,6 +4,8 @@
 
 This action downloads the `docker-compose` command and add it to the `PATH` for following executions. It supports the Linux environment only.
 
+⚠ 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:
@@ -12,7 +14,18 @@ Add a step to your workflow like below:
   steps:
   - uses: KengoTODA/actions-setup-docker-compose@main
     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 you can omit it then 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,21 +1,27 @@
 import {install, runCommand} from '../src/install'
 import * as core from '@actions/core'
 
-import {expect, test} from '@jest/globals'
+import {describe, expect, it, test} from '@jest/globals'
 
-test('runCommand', async () => {
-  const result = await runCommand('echo foo bar')
-  expect(result).toBe('foo bar')
+describe('runCommand', () => {
+  it('runs a command and returns its stdout', async () => {
+    const result = await runCommand('echo foo bar')
+    expect(result).toBe('foo bar')
+  })
 })
 
-async function testVersion(version: string) {
-  const commandPath = await install(version)
-  core.addPath(commandPath)
-  const result = await runCommand('docker-compose version')
-  expect(result).toContain(version)
-}
-
-test('Install the right version', async () => {
-  await testVersion('1.29.1')
-  await testVersion('1.29.2')
+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: 'node16'
   main: 'dist/index.js'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kengotoda/actions-setup-docker-compose",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "description": "the GitHub Action setting up docker-compose command",
   "main": "lib/main.js",
   "private": false,
@@ -30,21 +30,22 @@
   "dependencies": {
     "@actions/core": "^1.4.0",
     "@actions/exec": "^1.1.0",
-    "@actions/tool-cache": "^1.7.1"
+    "@actions/tool-cache": "^2.0.1",
+    "@octokit/action": "^4.0.10"
   },
   "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.31.0",
-    "eslint": "^7.30.0",
-    "eslint-plugin-github": "^4.1.3",
-    "eslint-plugin-jest": "^24.3.6",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/node": "^18.0.0",
+    "@typescript-eslint/parser": "^5.3.0",
+    "@vercel/ncc": "^0.36.0",
+    "eslint": "^8.1.0",
+    "eslint-plugin-github": "^4.3.3",
+    "eslint-plugin-jest": "^27.0.1",
     "jest": "^27.0.6",
     "js-yaml": "^4.1.0",
-    "prettier": "2.4.1",
-    "semantic-release": "^17.4.4",
+    "prettier": "2.8.2",
+    "semantic-release": "^19.0.2",
     "ts-jest": "^27.0.3",
     "typescript": "^4.3.5"
   },

src/install.ts

@@ -1,5 +1,7 @@
 import {cacheFile, downloadTool} from '@actions/tool-cache'
 import {exec} from '@actions/exec'
+import * as core from '@actions/core'
+import {Octokit} from '@octokit/action'
 
 export async function runCommand(command: string): Promise<string> {
   let output = ''
@@ -19,6 +21,9 @@ 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')
+  if (!version.startsWith('v') && parseInt(version.split('.')[0], 10) >= 2) {
+    version = `v${version}`
+  }
   const url = `https://github.com/docker/compose/releases/download/${version}/docker-compose-${await system}-${await hardware}`
   const installerPath = await downloadTool(url)
   await exec(`chmod +x ${installerPath}`)
@@ -31,7 +36,20 @@ async function installOnLinux(version: string): Promise<string> {
   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,7 +4,7 @@ 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)

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. */