https://github.com/supabase/setup-cli
A GitHub action for interacting with your Supabase projects using the CLI.
https://github.com/supabase/setup-cli
Last synced: about 1 year ago
JSON representation
A GitHub action for interacting with your Supabase projects using the CLI.
- Host: GitHub
- URL: https://github.com/supabase/setup-cli
- Owner: supabase
- License: mit
- Created: 2022-08-03T13:31:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T06:48:17.000Z (over 1 year ago)
- Last Synced: 2025-05-08T09:23:44.406Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 797 KB
- Stars: 139
- Watchers: 18
- Forks: 18
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# :gear: Supabase CLI Action
## About
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.
## Usage
Setup the `supabase` CLI:
```yaml
steps:
- uses: supabase/setup-cli@v1
```
A specific version of the `supabase` CLI can be installed:
```yaml
steps:
- uses: supabase/setup-cli@v1
with:
version: 2.20.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:
| Name | Type | Description | Default | Required |
| --------- | ------ | ---------------------------------- | -------- | -------- |
| `version` | String | Supabase CLI version (or `latest`) | `2.20.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 from dashboard url: https://app.supabase.com/project/
PROJECT_ID:
steps:
- uses: supabase/setup-cli@v1
- run: supabase link --project-ref $PROJECT_ID
- run: supabase db push
```
## Develop
> Requires `node >= 16`
Install the dependencies
```bash
$ npm install
```
Build the typescript and package it for distribution
```bash
$ npm run build && npm run package
```
Run the tests :heavy_check_mark:
```bash
$ npm test
PASS __tests__/main.test.ts
✓ gets download url to binary (3 ms)
✓ test runs (891 ms)
...
```
## Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
1. Create a new GitHub release
2. Rebase `v1` branch on `main`
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
```yaml
uses: ./
with:
version: latest
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket: