chore(release): 1.1.0 [skip ci]

# [1.1.0](https://github.com/KengoTODA/actions-setup-docker-compose/compare/v1.0.18...v1.1.0) (2022-12-25)

### Features

* Default docker-compose `version` to latest ([#643](https://github.com/KengoTODA/actions-setup-docker-compose/issues/643)) ([c61c6f5](c61c6f59f3))

.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/test.yml

@@ -21,6 +21,8 @@ jobs:
       - run: |
           npm ci
           npm run all
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Run semantic-release
         run: |
           npx semantic-release
@@ -29,6 +31,8 @@ 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@v3
       - uses: ./
@@ -40,6 +44,10 @@ jobs:
       - uses: ./
         with:
           version: 'v2.4.1'
+      - uses: ./
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   actionlint:
     runs-on: ubuntu-latest
     if: github.event.pull_request

README.md

@@ -12,7 +12,18 @@ Add a step to your workflow like below:
   steps:
   - uses: KengoTODA/actions-setup-docker-compose@main
     with:
-      version: '1.29.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

@@ -18,4 +18,10 @@ describe('install', () => {
     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,7 +3,7 @@ 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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kengotoda/actions-setup-docker-compose",
-  "version": "1.0.18",
+  "version": "1.1.0",
   "description": "the GitHub Action setting up docker-compose command",
   "main": "lib/main.js",
   "private": false,
@@ -30,20 +30,21 @@
   "dependencies": {
     "@actions/core": "^1.4.0",
     "@actions/exec": "^1.1.0",
-    "@actions/tool-cache": "^2.0.1"
+    "@actions/tool-cache": "^2.0.1",
+    "@octokit/action": "^4.0.10"
   },
   "devDependencies": {
     "@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.34.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.7.1",
+    "prettier": "2.8.1",
     "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 = ''
@@ -34,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)