mirror of
https://github.com/supabase/setup-cli.git
synced 2026-06-27 17:36:57 +00:00
3dacd93e8f
The `latest` channel resolves through the GitHub `/releases/latest` endpoint, which never returns prereleases, so there was no way to track the CLI beta channel — any other value was treated as an exact version. Add a `beta` channel that lists releases and installs the most recent beta prerelease. This lets consumers surface (and fix) breakages early. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01APKXLPMGXsnWUSU3i16Lfv
185 lines
5.4 KiB
Markdown
185 lines
5.4 KiB
Markdown
# :gear: Supabase CLI Action
|
|
|
|
[](https://github.com/supabase/setup-cli/actions/workflows/ci.yml)
|
|
[](https://github.com/supabase/setup-cli/actions/workflows/e2e.yml)
|
|
[](https://github.com/supabase/setup-cli/actions/workflows/codeql-analysis.yml)
|
|
|
|
## About
|
|
|
|
This composite 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@v2
|
|
```
|
|
|
|
If `version` is omitted, the action checks the repository root for `bun.lock`,
|
|
`pnpm-lock.yaml`, or `package-lock.json` and uses the declared `supabase`
|
|
version. If no supported lockfile is present, it falls back to `latest`.
|
|
|
|
A specific version of the `supabase` CLI can be installed:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: supabase/setup-cli@v2
|
|
with:
|
|
version: 2.84.2
|
|
```
|
|
|
|
To always track the latest beta prerelease, set `version` to `beta`. This is
|
|
useful for surfacing (and fixing) breakages early:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: supabase/setup-cli@v2
|
|
with:
|
|
version: beta
|
|
github-token: ${{ github.token }}
|
|
```
|
|
|
|
Run `supabase db start` to execute all migrations on a fresh database:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: supabase/setup-cli@v2
|
|
with:
|
|
version: latest
|
|
github-token: ${{ github.token }}
|
|
- 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 action supports the following inputs:
|
|
|
|
| Name | Type | Description | Default | Required |
|
|
| -------------- | ------ | --------------------------------------------------------------------------------- | --------------------------------- | -------- |
|
|
| `version` | String | Supabase CLI version (or `latest`, or `beta` for the latest beta release) | Root lockfile version or `latest` | false |
|
|
| `github-token` | String | GitHub token used to resolve `latest`/`beta` without unauthenticated API limiting | | false |
|
|
|
|
## Advanced Usage
|
|
|
|
Check generated TypeScript types are up-to-date with Postgres schema:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: supabase/setup-cli@v2
|
|
- 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@v2
|
|
- run: supabase link --project-ref $PROJECT_ID
|
|
- run: supabase db push
|
|
```
|
|
|
|
Export local Supabase env vars for app tests:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: supabase/setup-cli@v2
|
|
- run: supabase init
|
|
- run: supabase start
|
|
- name: Export local Supabase env vars
|
|
run: |
|
|
# Customize the variable names as needed for your app.
|
|
supabase status -o env \
|
|
--override-name api.url=SUPABASE_URL \
|
|
--override-name auth.service_role_key=SUPABASE_SERVICE_ROLE_KEY \
|
|
>> .env.test
|
|
- run: bun test
|
|
```
|
|
|
|
## Develop
|
|
|
|
After you've cloned the repository to your local machine or codespace, you'll
|
|
need to perform a few setup steps before you can work on the action.
|
|
|
|
> [!NOTE]
|
|
>
|
|
> You'll need a recent version of [Bun](https://bun.sh) for local development.
|
|
> This repository includes a `.bun-version` file for tools that can auto-switch
|
|
> Bun versions.
|
|
|
|
1. :hammer_and_wrench: Install the dependencies
|
|
|
|
```bash
|
|
bun install
|
|
```
|
|
|
|
1. :white_check_mark: Run the tests
|
|
|
|
```bash
|
|
bun test
|
|
```
|
|
|
|
1. :mag: Run the full local CI suite
|
|
|
|
```bash
|
|
bun run ci
|
|
```
|
|
|
|
## Publish
|
|
|
|
1. Create a new GitHub release
|
|
2. Rebase `v2` 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
|
|
|
|
Validate changes by exercising the action from a workflow in this repository
|
|
(see [ci.yml](.github/workflows/ci.yml) and [e2e.yml](.github/workflows/e2e.yml)).
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: ./
|
|
with:
|
|
version: latest
|
|
github-token: ${{ github.token }}
|
|
```
|
|
|
|
The CI workflow provides fast smoke coverage across GitHub-hosted runners, and
|
|
the E2E workflow verifies `supabase init` and `supabase start` against supported
|
|
Postgres versions. See the [actions tab](https://github.com/supabase/setup-cli/actions)
|
|
for recent runs.
|