feat: bump default cli version to 1.178.2 (#287)

* feat: bump default cli version to 1.176.10

* Update action.yml

* Update README.md

* Update README.md

* Update start.yml

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
Co-authored-by: Han Qiao <qiao@supabase.io>

.github/workflows/check-dist.yml

@@ -21,12 +21,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set Node.js 16.x
+      - name: Set Node.js 20.x
-        uses: actions/setup-node@v3.5.1
+        uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 20.x
+          cache: npm
 
       - name: Install dependencies
         run: npm ci
@@ -46,7 +47,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/codeql-analysis.yml

@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         source-root: src
@@ -54,7 +54,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/dependabot.yml

@@ -1,7 +1,7 @@
-# Adapted from https://blog.somewhatabstract.com/2021/10/11/setting-up-dependabot-with-github-actions-to-approve-and-merge/
+# Adapted from https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request
 name: Dependabot auto-merge
 
-on: pull_request_target
+on: pull_request
 
 permissions:
   pull-requests: write
@@ -18,7 +18,7 @@ jobs:
       # will not occur.
       - name: Dependabot metadata
         id: dependabot-metadata
-        uses: dependabot/fetch-metadata@v1.3.5
+        uses: dependabot/fetch-metadata@v2.1.0
         with:
           github-token: '${{ secrets.GITHUB_TOKEN }}'
 

.github/workflows/start.yml

@@ -8,6 +8,7 @@ on:
   schedule:
     # * is a special character in YAML so you have to quote this string
     - cron: '30 1,9 * * *'
+  workflow_dispatch:
 
 defaults:
   run:
@@ -19,12 +20,16 @@ jobs:
     strategy:
       matrix:
         version:
-          - 1.0.0
+          - 1.178.2
           - latest
+        pg_major:
+          - 14
+          - 15
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         with:
           version: ${{ matrix.version }}
       - run: supabase init
+      - run: sed -i -E "s|^(major_version) .*|\1 = ${{ matrix.pg_major }}|" supabase/config.toml
       - run: supabase start

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm install
       - run: npm run all
   test: # make sure the action works on a clean machine without building
@@ -23,7 +23,7 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
         version: [1.0.0, latest]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         with:
           version: ${{ matrix.version }}

README.md

@@ -5,7 +5,7 @@
 
 ## About
 
-This action sets up the Supabase CLI, [`supabase`](https://github.com/supabase/cli), on GitHub's hosted Actions runners.
+This action sets up the Supabase CLI, [`supabase`](https://github.com/supabase/cli), on GitHub's hosted Actions runners. Other CI runners like [BitBucket](https://bitbucket.org/supabase-cli/setup-cli/src/master/bitbucket-pipelines.yml) and [GitLab](https://gitlab.com/sweatybridge/setup-cli/-/blob/main/.gitlab-ci.yml) are supported via their respective pipelines.
 
 This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the `supabase` CLI on the runner environment.
 
@@ -24,7 +24,7 @@ A specific version of the `supabase` CLI can be installed:
 steps:
   - uses: supabase/setup-cli@v1
     with:
-      version: 1.28.3
+      version: 1.178.2
 ```
 
 Run `supabase db start` to execute all migrations on a fresh database:
@@ -44,9 +44,9 @@ Since Supabase CLI relies on Docker Engine API, additional setup may be required
 
 The actions supports the following inputs:
 
-| Name      | Type   | Description                        | Default  | Required |
+| Name      | Type   | Description                        | Default   | Required |
-| --------- | ------ | ---------------------------------- | -------- | -------- |
+| --------- | ------ | ---------------------------------- | --------- | -------- |
-| `version` | String | Supabase CLI version (or `latest`) | `1.28.3` | false    |
+| `version` | String | Supabase CLI version (or `latest`) | `1.178.2` | false    |
 
 ## Advanced Usage
 
@@ -114,16 +114,8 @@ $ npm test
 
 Actions are run from GitHub repos so we will checkin the packed dist folder.
 
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
+1. Create a new GitHub release
-
+2. Rebase `v1` branch on `main`
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "Update dependencies"
-$ git push origin releases/v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
 
 Your action is now published! :rocket:
 

__tests__/main.test.ts

@@ -1,8 +1,11 @@
 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 () => {
@@ -36,11 +39,17 @@ test('gets download url to latest version', async () => {
 // 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'] = '1.0.0'
+  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,10 @@ inputs:
   version:
     description: Version of Supabase CLI to install
     required: false
-    default: 1.28.3
+    default: 1.178.2
+outputs:
+  version:
+    description: Version of installed Supabase CLI
 runs:
-  using: node16
+  using: node20
   main: dist/index.js

dist/index.js

@@ -42,10 +42,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.CLI_CONFIG_REGISTRY = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const tc = __importStar(__nccwpck_require__(7784));
-const lt_1 = __importDefault(__nccwpck_require__(194));
+const gte_1 = __importDefault(__nccwpck_require__(5522));
 const utils_1 = __nccwpck_require__(918);
+exports.CLI_CONFIG_REGISTRY = 'SUPABASE_INTERNAL_IMAGE_REGISTRY';
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -58,9 +60,12 @@ function run() {
             const pathToCLI = yield tc.extractTar(pathToTarball);
             // Expose the tool by adding it to the PATH
             core.addPath(pathToCLI);
+            // Expose installed tool version
+            const determinedVersion = yield (0, utils_1.determineInstalledVersion)();
+            core.setOutput('version', determinedVersion);
             // Use GHCR mirror by default
-            if (version.toLowerCase() === 'latest' || (0, lt_1.default)(version, '1.28.0')) {
+            if (version.toLowerCase() === 'latest' || (0, gte_1.default)(version, '1.28.0')) {
-                core.exportVariable('SUPABASE_INTERNAL_IMAGE_REGISTRY', 'ghcr.io');
+                core.exportVariable(exports.CLI_CONFIG_REGISTRY, 'ghcr.io');
             }
         }
         catch (error) {
@@ -92,9 +97,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getDownloadUrl = void 0;
+exports.determineInstalledVersion = exports.getDownloadUrl = void 0;
+const child_process_1 = __nccwpck_require__(2081);
 const os_1 = __importDefault(__nccwpck_require__(2037));
 const lt_1 = __importDefault(__nccwpck_require__(194));
+const util_1 = __nccwpck_require__(3837);
+const doExec = (0, util_1.promisify)(child_process_1.exec);
 // arch in [arm, arm64, x64...] (https://nodejs.org/docs/latest-v16.x/api/os.html#osarch)
 // return value in [amd64, arm64, arm]
 const mapArch = (arch) => {
@@ -124,6 +132,15 @@ const getDownloadUrl = (version) => __awaiter(void 0, void 0, void 0, function*
     return `https://github.com/supabase/cli/releases/download/v${version}/${filename}`;
 });
 exports.getDownloadUrl = getDownloadUrl;
+const determineInstalledVersion = () => __awaiter(void 0, void 0, void 0, function* () {
+    const { stdout } = yield doExec('supabase --version');
+    const version = stdout.trim();
+    if (!version) {
+        throw new Error('Could not determine installed Supabase CLI version');
+    }
+    return version;
+});
+exports.determineInstalledVersion = determineInstalledVersion;
 
 
 /***/ }),
@@ -6606,6 +6623,16 @@ const compare = (a, b, loose) =>
 module.exports = compare
 
 
+/***/ }),
+
+/***/ 5522:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+const compare = __nccwpck_require__(4309)
+const gte = (a, b, loose) => compare(a, b, loose) >= 0
+module.exports = gte
+
+
 /***/ }),
 
 /***/ 194:

docs/index.md

@@ -0,0 +1,35 @@
+# `supabase-github-action`
+
+The Supabase GitHub Action provides an easy way to use the Supabase CLI on GitHub's hosted Actions runners.
+
+The action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the Supabase CLI on the runner environment.
+
+## Quick start
+
+This example shows how you can use the Supabase GitHub Action to test your migrations on every Pull Request.
+
+Inside your repository, create a new file inside the `.github/workflows` folder called `test-migrations.yml`.
+
+Copy this snippet inside the file, and the action will run whenever a new PR is created:
+
+```yaml
+name: 'test-migrations'
+on:
+  pull_request:
+
+jobs:
+  build: 
+    runs-on: ubuntu-latest
+    steps:
+        - uses: supabase/setup-cli@v1
+            with:
+            version: latest
+        - run: supabase init
+        - run: supabase db start
+```
+
+
+## Resources
+
+- **Source Code**: <a href="https://github.com/supabase/supabase-github-action" target="_blank">github.com/supabase/supabase-github-action</a>
+- **CLI Documentation**: <a href="https://supabase.com/docs/guides/cli" target="_blank">supabase.com/docs/guides/cli</a>

mkdocs.yaml

@@ -0,0 +1,33 @@
+site_name: supabase-github-action
+site_url: https://supabase.github.io/supabase-github-action
+site_description: A GitHub action for interacting with your Supabase projects using the CLI. 
+
+repo_name: supabase/supabase-github-action
+repo_url: https://github.com/supabase/supabase-github-action
+
+nav:
+    - Welcome: 'index.md'
+
+theme:
+    name: 'material'
+    features:
+      - navigation.expand
+    favicon: 'assets/favicon.ico'
+    logo: 'assets/favicon.ico'
+    homepage: https://supabase.github.io/supabase-github-action
+    palette:
+        primary: black
+        accent: light green
+
+markdown_extensions:
+    - pymdownx.highlight:
+        linenums: true
+        guess_lang: false
+        use_pygments: true
+        pygments_style: default
+    - pymdownx.superfences
+    - pymdownx.tabbed:
+        alternate_style: true
+    - pymdownx.snippets
+    - pymdownx.tasklist
+    - admonition

package.json

@@ -25,20 +25,22 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.10.1",
     "@actions/tool-cache": "^2.0.1",
-    "semver": "^7.3.8"
+    "semver": "^7.6.2"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^16.11.47",
-    "@types/semver": "^7.3.13",
+    "@types/semver": "^7.5.8",
-    "@typescript-eslint/parser": "^5.48.0",
+    "@typescript-eslint/parser": "^5.62.0",
-    "@vercel/ncc": "^0.36.0",
+    "@vercel/ncc": "^0.38.1",
-    "eslint": "^8.31.0",
+    "eslint": "^8.57.0",
-    "eslint-plugin-github": "^4.6.0",
+    "eslint-plugin-github": "^4.9.0",
-    "eslint-plugin-jest": "^27.2.0",
+    "eslint-plugin-jest": "^27.9.0",
     "jest": "^28.1.3",
-    "prettier": "2.8.1",
+    "js-yaml": "^4.1.0",
+    "prettier": "2.8.8",
     "ts-jest": "^28.0.8",
     "typescript": "^4.8.4"
   }

src/main.ts

@@ -1,7 +1,9 @@
 import * as core from '@actions/core'
 import * as tc from '@actions/tool-cache'
-import gte from 'semver/functions/lt'
+import gte from 'semver/functions/gte'
-import {getDownloadUrl} from './utils'
+import {getDownloadUrl, determineInstalledVersion} from './utils'
+
+export const CLI_CONFIG_REGISTRY = 'SUPABASE_INTERNAL_IMAGE_REGISTRY'
 
 async function run(): Promise<void> {
   try {
@@ -18,9 +20,13 @@ async function run(): Promise<void> {
     // Expose the tool by adding it to the PATH
     core.addPath(pathToCLI)
 
+    // Expose installed tool version
+    const determinedVersion = await determineInstalledVersion()
+    core.setOutput('version', determinedVersion)
+
     // Use GHCR mirror by default
     if (version.toLowerCase() === 'latest' || gte(version, '1.28.0')) {
-      core.exportVariable('SUPABASE_INTERNAL_IMAGE_REGISTRY', 'ghcr.io')
+      core.exportVariable(CLI_CONFIG_REGISTRY, 'ghcr.io')
     }
   } catch (error) {
     if (error instanceof Error) core.setFailed(error.message)

src/utils.ts

@@ -1,5 +1,9 @@
+import {exec} from 'child_process'
 import os from 'os'
 import lt from 'semver/functions/lt'
+import {promisify} from 'util'
+
+const doExec = promisify(exec)
 
 // arch in [arm, arm64, x64...] (https://nodejs.org/docs/latest-v16.x/api/os.html#osarch)
 // return value in [amd64, arm64, arm]
@@ -31,3 +35,14 @@ export const getDownloadUrl = async (version: string): Promise<string> => {
   }
   return `https://github.com/supabase/cli/releases/download/v${version}/${filename}`
 }
+
+export const determineInstalledVersion = async (): Promise<string> => {
+  const {stdout} = await doExec('supabase --version')
+
+  const version = stdout.trim()
+  if (!version) {
+    throw new Error('Could not determine installed Supabase CLI version')
+  }
+
+  return version
+}