fix: inverted conditional for semver check (#129)

* fix: inverted conditional for semver check

* chore: add tests for default version

* chore: parse default action input

* chore: update binary files

* chore: fix unit test

.github/workflows/check-dist.yml

@@ -24,9 +24,10 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Set Node.js 16.x
-        uses: actions/setup-node@v3.4.1
+        uses: actions/setup-node@v3.6.0
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Install dependencies
         run: npm ci
@@ -38,7 +39,7 @@ jobs:
 
       - name: Compare the expected and actual dist/ directories
         run: |
-          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
+          if ! git diff --ignore-space-at-eol --exit-code --quiet dist/; then
             echo "Detected uncommitted changes after build.  See status below:"
             git diff
             exit 1

.github/workflows/dependabot.yml

@@ -0,0 +1,40 @@
+# Adapted from https://blog.somewhatabstract.com/2021/10/11/setting-up-dependabot-with-github-actions-to-approve-and-merge/
+name: Dependabot auto-merge
+
+on: pull_request_target
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    # Checking the actor will prevent your Action run failing on non-Dependabot
+    # PRs but also ensures that it only does work for Dependabot PRs.
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      # This first step will fail if there's no metadata and so the approval
+      # will not occur.
+      - name: Dependabot metadata
+        id: dependabot-metadata
+        uses: dependabot/fetch-metadata@v1.3.6
+        with:
+          github-token: '${{ secrets.GITHUB_TOKEN }}'
+
+      # Here the PR gets approved.
+      - name: Approve a PR
+        if: ${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }}
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # Finally, this sets the PR to allow auto-merging for patch and minor
+      # updates if all checks pass
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/start.yml

@@ -0,0 +1,30 @@
+name: CLI Start
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron: '30 1,9 * * *'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  e2e: # make sure the action works on a clean machine without building
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version:
+          - 1.0.0
+          - latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./
+        with:
+          version: ${{ matrix.version }}
+      - run: supabase init
+      - run: supabase start

.github/workflows/test.yml

@@ -4,7 +4,6 @@ on: # rebuild any PRs and main branch changes
   push:
     branches:
       - main
-      - 'releases/*'
 
 defaults:
   run:
@@ -22,10 +21,18 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        version: [0.32.1, 0.32.0]
+        version: [1.0.0, latest]
     steps:
       - uses: actions/checkout@v3
       - uses: ./
         with:
           version: ${{ matrix.version }}
       - run: supabase -h
+  check:
+    if: ${{ always() && github.event.pull_request }}
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - run: |
+          result="${{ needs.test.result }}"
+          [[ $result == "success" || $result == "skipped" ]]

CODEOWNERS

@@ -1 +1 @@
-* @actions/actions-runtime
+* @soedirgo @sweatybridge

README.md

@@ -24,14 +24,63 @@ A specific version of the `supabase` CLI can be installed:
 steps:
   - uses: supabase/setup-cli@v1
     with:
-      version: 0.32.1
+      version: 1.28.3
 ```
 
+Run `supabase db start` to execute all migrations on a fresh database:
+
+```yaml
+steps:
+  - uses: supabase/setup-cli@v1
+    with:
+      version: latest
+  - run: supabase init
+  - run: supabase db start
+```
+
+Since Supabase CLI relies on Docker Engine API, additional setup may be required on Windows and macOS runners.
+
 ## Inputs
 
 The actions supports the following inputs:
 
-- `version`: The version of `supabase` to install, defaulting to `0.32.1`
+| Name      | Type   | Description                        | Default  | Required |
+| --------- | ------ | ---------------------------------- | -------- | -------- |
+| `version` | String | Supabase CLI version (or `latest`) | `1.28.3` | false    |
+
+## Advanced Usage
+
+Check generated TypeScript types are up-to-date with Postgres schema:
+
+```yaml
+steps:
+  - uses: supabase/setup-cli@v1
+  - run: supabase init
+  - run: supabase db start
+  - name: Verify generated types match Postgres schema
+    run: |
+      supabase gen types typescript --local > schema.gen.ts
+      if ! git diff --ignore-space-at-eol --exit-code --quiet schema.gen.ts; then
+        echo "Detected uncommitted changes after build. See status below:"
+        git diff
+        exit 1
+      fi
+```
+
+Release job to push schema changes to a Supabase project:
+
+```yaml
+env:
+  SUPABASE_ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+  SUPABASE_DB_PASSWORD: ${{ secrets.DB_PASSWORD }}
+  # Retrieve <project-id> from dashboard url: https://app.supabase.com/project/<project-id>
+  PROJECT_ID: <project-id>
+
+ steps:
+   - uses: supabase/setup-cli@v1
+   - run: supabase link --project-ref $PROJECT_ID
+   - run: supabase db push
+```
 
 ## Develop
 
@@ -87,7 +136,7 @@ You can now validate the action by referencing `./` in a workflow in your repo (
 ```yaml
 uses: ./
 with:
-  version: 0.32.1
+  version: latest
 ```
 
 See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:

__tests__/main.test.ts

@@ -1,25 +1,55 @@
 import {getDownloadUrl} from '../src/utils'
+import {CLI_CONFIG_REGISTRY} from '../src/main'
 import * as os from 'os'
 import * as process from 'process'
 import * as cp from 'child_process'
 import * as path from 'path'
+import * as fs from 'fs'
+import * as yaml from 'js-yaml'
 import {expect, test} from '@jest/globals'
 
 test('gets download url to binary', async () => {
-  const url = getDownloadUrl('0.1.0')
-  expect(url).toContain(
-    'https://github.com/supabase/cli/releases/download/v0.1.0/'
+  const url = await getDownloadUrl('1.28.0')
+  expect(
+    url.startsWith(
+      'https://github.com/supabase/cli/releases/download/v1.28.0/supabase_'
+    )
+  ).toBeTruthy()
+  expect(url.endsWith('.tar.gz')).toBeTruthy()
+  expect(url).not.toContain('_1.28.0_')
+})
+
+test('gets legacy download url to binary', async () => {
+  const url = await getDownloadUrl('0.1.0')
+  expect(
+    url.startsWith(
+      `https://github.com/supabase/cli/releases/download/v0.1.0/supabase_0.1.0_`
+    )
+  ).toBeTruthy()
+  expect(url.endsWith('.tar.gz')).toBeTruthy()
+})
+
+test('gets download url to latest version', async () => {
+  const url = await getDownloadUrl('latest')
+  expect(url).toMatch(
+    'https://github.com/supabase/cli/releases/latest/download/'
   )
 })
 
 // shows how the runner will run a javascript action with env / stdout protocol
 test('test runs', () => {
   process.env['RUNNER_TEMP'] = os.tmpdir()
-  process.env['INPUT_VERSION'] = '0.32.1'
+  const config = path.join(__dirname, '..', 'action.yml')
+  const action: any = yaml.load(fs.readFileSync(config, 'utf8'))
+  process.env['INPUT_VERSION'] = action.inputs.version.default
   const np = process.execPath
   const ip = path.join(__dirname, '..', 'lib', 'main.js')
   const options: cp.ExecFileSyncOptions = {
     env: process.env
   }
-  console.log(cp.execFileSync(np, [ip], options).toString())
+  const stdout = cp.execFileSync(np, [ip], options).toString()
+  console.log(stdout)
+  expect
+    .stringContaining(`::set-env name=${CLI_CONFIG_REGISTRY}::`)
+    .asymmetricMatch(stdout)
 })

action.yml

@@ -5,7 +5,7 @@ inputs:
   version:
     description: Version of Supabase CLI to install
     required: false
-    default: 0.32.1
+    default: 1.28.3
 runs:
   using: node16
   main: dist/index.js

dist/licenses.txt

@@ -119,22 +119,10 @@ uuid
 MIT
 The MIT License (MIT)
 
-Copyright (c) 2010-2016 Robert Kieffer and other contributors
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -25,19 +25,23 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.9.0",
-    "@actions/tool-cache": "^2.0.1"
+    "@actions/core": "^1.10.0",
+    "@actions/tool-cache": "^2.0.1",
+    "semver": "^7.3.8"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
     "@types/node": "^16.11.47",
-    "@typescript-eslint/parser": "^5.32.0",
-    "@vercel/ncc": "^0.34.0",
-    "eslint": "^8.0.1",
-    "eslint-plugin-github": "^4.3.7",
-    "eslint-plugin-jest": "^26.7.0",
+    "@types/semver": "^7.3.13",
+    "@typescript-eslint/parser": "^5.49.0",
+    "@vercel/ncc": "^0.36.1",
+    "eslint": "^8.32.0",
+    "eslint-plugin-github": "^4.6.0",
+    "eslint-plugin-jest": "^27.2.1",
     "jest": "^28.1.3",
-    "prettier": "2.7.1",
-    "ts-jest": "^28.0.7",
-    "typescript": "^4.7.4"
+    "js-yaml": "^4.1.0",
+    "prettier": "2.8.3",
+    "ts-jest": "^28.0.8",
+    "typescript": "^4.8.4"
   }
 }

src/main.ts

@@ -1,14 +1,17 @@
 import * as core from '@actions/core'
 import * as tc from '@actions/tool-cache'
+import gte from 'semver/functions/gte'
 import {getDownloadUrl} from './utils'
 
+export const CLI_CONFIG_REGISTRY = 'SUPABASE_INTERNAL_IMAGE_REGISTRY'
+
 async function run(): Promise<void> {
   try {
     // Get version of tool to be installed
     const version = core.getInput('version')
 
     // Download the specific version of the tool, e.g. as a tarball/zipball
-    const download = getDownloadUrl(version)
+    const download = await getDownloadUrl(version)
     const pathToTarball = await tc.downloadTool(download)
 
     // Extract the tarball/zipball onto host runner
@@ -16,6 +19,11 @@ async function run(): Promise<void> {
 
     // Expose the tool by adding it to the PATH
     core.addPath(pathToCLI)
+
+    // Use GHCR mirror by default
+    if (version.toLowerCase() === 'latest' || gte(version, '1.28.0')) {
+      core.exportVariable(CLI_CONFIG_REGISTRY, 'ghcr.io')
+    }
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)
   }

src/utils.ts

@@ -1,4 +1,5 @@
 import os from 'os'
+import lt from 'semver/functions/lt'
 
 // arch in [arm, arm64, x64...] (https://nodejs.org/docs/latest-v16.x/api/os.html#osarch)
 // return value in [amd64, arm64, arm]
@@ -18,9 +19,15 @@ const mapOS = (platform: string): string => {
   return mappings[platform] || platform
 }
 
-export const getDownloadUrl = (version: string): string => {
+export const getDownloadUrl = async (version: string): Promise<string> => {
   const platform = mapOS(os.platform())
   const arch = mapArch(os.arch())
-  const filename = `supabase_${version}_${platform}_${arch}`
-  return `https://github.com/supabase/cli/releases/download/v${version}/${filename}.tar.gz`
+  const filename = `supabase_${platform}_${arch}.tar.gz`
+  if (version.toLowerCase() === 'latest') {
+    return `https://github.com/supabase/cli/releases/latest/download/${filename}`
+  }
+  if (lt(version, '1.28.0')) {
+    return `https://github.com/supabase/cli/releases/download/v${version}/supabase_${version}_${platform}_${arch}.tar.gz`
+  }
+  return `https://github.com/supabase/cli/releases/download/v${version}/${filename}`
 }