Add denoland setup step to testing.md (#320)

* fix: indentation in docs page

* fix: indentation in docs page

* fix: indentation in docs page

.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.5.1
+        uses: actions/setup-node@v3.7.0
         with:
           node-version: 16.x
+          cache: npm
 
       - name: Install dependencies
         run: npm ci

.github/workflows/dependabot.yml

@@ -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@v1.6.0
         with:
           github-token: '${{ secrets.GITHUB_TOKEN }}'
 

.github/workflows/start.yml

@@ -4,7 +4,7 @@ on:
     branches:
       - main
     tags:
-      - 'v*'
+      - '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 * * *'
@@ -13,9 +13,6 @@ defaults:
   run:
     shell: bash
 
-env:
-  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
 jobs:
   e2e: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -9,9 +9,6 @@ defaults:
   run:
     shell: bash
 
-env:
-  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
 jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest

README.md

@@ -24,7 +24,7 @@ A specific version of the `supabase` CLI can be installed:
 steps:
   - uses: supabase/setup-cli@v1
     with:
-      version: 1.28.0
+      version: 1.28.3
 ```
 
 Run `supabase db start` to execute all migrations on a fresh database:
@@ -46,7 +46,7 @@ The actions supports the following inputs:
 
 | Name      | Type   | Description                        | Default  | Required |
 | --------- | ------ | ---------------------------------- | -------- | -------- |
-| `version` | String | Supabase CLI version (or `latest`) | `1.28.0` | false    |
+| `version` | String | Supabase CLI version (or `latest`) | `1.28.3` | false    |
 
 ## Advanced Usage
 
@@ -117,10 +117,11 @@ 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:
 
 ```bash
-$ npm run package
+$ npm run all
 $ git add dist
 $ git commit -a -m "Update dependencies"
-$ git push origin releases/v1
+$ git tag -f v1
+$ git push -f --tags
 ```
 
 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.

__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.0
+    default: 1.28.3
+outputs:
+  version:
+    description: Version of installed Supabase CLI
 runs:
   using: node16
   main: dist/index.js

dist/index.js

@@ -38,10 +38,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+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 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 {
@@ -54,6 +60,13 @@ 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, gte_1.default)(version, '1.28.0')) {
+                core.exportVariable(exports.CLI_CONFIG_REGISTRY, 'ghcr.io');
+            }
         }
         catch (error) {
             if (error instanceof Error)
@@ -84,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) => {
@@ -116,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;
 
 
 /***/ }),
@@ -6598,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/backups.md

@@ -0,0 +1,83 @@
+# Backup your database
+
+You can use the Supabase CLI to backup your Postgres database. The steps involve running a series of commands to dump roles, schema, and data separately.
+Inside your repository, create a new file inside the `.github/workflows` folder called `backup.yml`. Copy the following snippet inside the file, and the action will run whenever a new PR is created.
+
+!!! note
+
+    Never backup your data to a public repository. 
+
+## Backup action
+
+```yaml
+name: 'backup-database'
+on:
+  pull_request:
+jobs:
+  build: 
+    runs-on: ubuntu-latest
+    env:
+      supabase_db_url: ${{ secrets.SUPABASE_DB_URL }}   # For example: postgresql://postgres:[YOUR-PASSWORD]@db.<ref>.supabase.co:5432/postgres
+    steps:
+      - uses: actions/checkout@v2
+      - uses: supabase/setup-cli@v1
+        with:
+          version: latest
+      - name: Backup roles
+        run: supabase db dump --db-url "$supabase_db_url" -f roles.sql --role-only
+      - name: Backup schema
+        run: supabase db dump --db-url "$supabase_db_url" -f schema.sql
+      - name: Backup data
+        run: supabase db dump --db-url "$supabase_db_url" -f data.sql --data-only --use-copy
+```
+## Periodic Backups Workflow
+
+You can use the GitHub Action to run periodic backups of your database. In this example, the Action workflow is triggered by `push` and `pull_request` events on the `main` branch, manually via `workflow_dispatch`, and automatically at midnight every day due to the `schedule` event with a `cron` expression.
+The workflow runs on the latest Ubuntu runner and requires write permissions to the repository's contents. It uses the Supabase CLI to dump the roles, schema, and data from your Supabase database, utilizing the `SUPABASE_DB_URL` environment variable that is securely stored in the GitHub secrets.
+After the backup is complete, it auto-commits the changes to the repository using the `git-auto-commit-action`. This ensures that the latest backup is always available in your repository. The commit message for these automated commits is "Supabase backup".
+This workflow provides an automated solution for maintaining regular backups of your Supabase database. It helps keep your data safe and enables easy restoration in case of any accidental data loss or corruption.
+
+!!! note
+
+    Never backup your data to a public repository. 
+
+```yaml
+name: Supa-backup
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *' # Runs every day at midnight
+jobs:   
+  run_db_backup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    env:
+      supabase_db_url: ${{ secrets.SUPABASE_DB_URL }}   # For example: postgresql://postgres:[YOUR-PASSWORD]@db.<ref>.supabase.co:5432/postgres
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - uses: supabase/setup-cli@v1
+        with:
+          version: latest
+      - name: Backup roles
+        run: supabase db dump --db-url "$supabase_db_url" -f roles.sql --role-only
+      - name: Backup schema
+        run: supabase db dump --db-url "$supabase_db_url" -f schema.sql
+      - name: Backup data
+        run: supabase db dump --db-url "$supabase_db_url" -f data.sql --data-only --use-copy
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Supabase backup
+```
+
+## More resources
+
+- Backing up and migrating your project: [Migrating and Upgrading](https://supabase.com/docs/guides/platform/migrating-and-upgrading-projects)

docs/generating-types.md

@@ -0,0 +1,36 @@
+# Generating Types
+
+You can use the Supabase CLI to automatically generate Typescript definitions from your Postgres database. You can then pass these definitions to your `supabase-js` client and get end-to-end type safety across client, server, and database.
+
+Inside your repository, create a new file inside the `.github/workflows` folder called `generate-types.yml`. Copy this snippet inside the file, and the action will run whenever a new PR is created:
+
+## Verify types
+
+```yaml
+name: 'generate-types'
+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
+        - 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
+```
+
+
+## More resources
+
+- Using supabase-js with type definitions: [Typescript Support](https://supabase.com/docs/reference/javascript/typescript-support)

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>

docs/migrations.md

@@ -0,0 +1,25 @@
+# Managing database migrations
+
+Migrations are programmatic changes to your database. They are usually checked into Git.
+
+## Testing your migrations
+
+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
+```

docs/testing.md

@@ -0,0 +1,59 @@
+# Automated testing
+
+You can use the Supabase CLI to run automated tests. 
+
+## Testing your database
+
+After you have [created unit tests](https://supabase.com/docs/guides/database/testing) for your database, you can use the GitHub Action to run the tests.
+
+Inside your repository, create a new file inside the `.github/workflows` folder called `database-tests.yml`. Copy this snippet inside the file, and the action will run whenever a new PR is created:
+
+```yaml
+name: 'database-tests'
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: supabase/setup-cli@v1
+        with:
+          version: latest
+      - run: supabase db start
+      - run: supabase test db
+
+```
+
+## Testing your Edge Functions
+
+After you have [created unit tests](https://supabase.com/docs/guides/functions/unit-test) for your Edge Functions, you can use the GitHub Action to run the tests.
+
+Inside your repository, create a new file inside the `.github/workflows` folder called `functions-tests.yml`. Copy this snippet inside the file, and the action will run whenever a new PR is created:
+
+```yaml
+name: 'functions-tests'
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: supabase/setup-cli@v1
+        with:
+          version: latest
+      - uses: denoland/setup-deno@v2
+        with:
+          deno-version: latest
+      - run: supabase start
+      - run: deno test --allow-all deno-test.ts --env-file .env.local
+
+```
+
+## More resources
+
+- Learn more about the [pgTAP extension](https://supabase.com/docs/guides/database/extensions/pgtap) for database testing.
+- Official pgTAP Documentation: [pgtap.org](https://pgtap.org/)

mkdocs.yaml

@@ -0,0 +1,34 @@
+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'
+    - Quickstart: 'migrations.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

@@ -27,18 +27,20 @@
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@actions/tool-cache": "^2.0.1",
-    "semver": "^7.3.8"
+    "semver": "^7.5.4"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.5",
     "@types/node": "^16.11.47",
-    "@types/semver": "^7.3.13",
-    "@typescript-eslint/parser": "^5.48.0",
-    "@vercel/ncc": "^0.36.0",
-    "eslint": "^8.31.0",
-    "eslint-plugin-github": "^4.6.0",
-    "eslint-plugin-jest": "^27.2.0",
+    "@types/semver": "^7.5.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "@vercel/ncc": "^0.36.1",
+    "eslint": "^8.45.0",
+    "eslint-plugin-github": "^4.9.0",
+    "eslint-plugin-jest": "^27.2.3",
     "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,6 +1,9 @@
 import * as core from '@actions/core'
 import * as tc from '@actions/tool-cache'
-import {getDownloadUrl} from './utils'
+import gte from 'semver/functions/gte'
+import {getDownloadUrl, determineInstalledVersion} from './utils'
+
+export const CLI_CONFIG_REGISTRY = 'SUPABASE_INTERNAL_IMAGE_REGISTRY'
 
 async function run(): Promise<void> {
   try {
@@ -16,6 +19,15 @@ 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(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
+}