feat: Default docker-compose version to latest (#643)

* test: add expected behavior as a test case Signed-off-by: Kengo TODA <skypencil@gmail.com> * implement the necessary feature Signed-off-by: Kengo TODA <skypencil@gmail.com> * add a missing return type Signed-off-by: Kengo TODA <skypencil@gmail.com> * ci: try to run action without GITHUB_TOKEN env var Signed-off-by: Kengo TODA <skypencil@gmail.com> * input version is not required Signed-off-by: Kengo TODA <skypencil@gmail.com> * update the distributed package Signed-off-by: Kengo TODA <skypencil@gmail.com> * fix eslint warning Signed-off-by: Kengo TODA <skypencil@gmail.com> * provide GITHUB_TOKEN to create Octokit Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: update README.md Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: update README.md Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: update README.md Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: update README.md Signed-off-by: Kengo TODA <skypencil@gmail.com> * update distributions Signed-off-by: Kengo TODA <skypencil@gmail.com> Signed-off-by: Kengo TODA <skypencil@gmail.com>
KengoTODA · Dec 25, 2022 · c61c6f5 · c61c6f5
1 parent 83838f3
commit c61c6f5
Show file tree

Hide file tree

Showing 11 changed files with 8,959 additions and 242 deletions.
diff --git a/.eslintrc.json b/.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",

diff --git a/.github/workflows/test.yml b/.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

diff --git a/README.md b/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.
diff --git a/__tests__/install.test.ts b/__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()
+  })
 })
diff --git a/action.yml b/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