⚙️
Supabase CLI Action
About
This action sets up the Supabase CLI, supabase, on GitHub's hosted Actions runners.
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:
steps:
- uses: supabase/setup-cli@v1
A specific version of the supabase CLI can be installed:
steps:
- uses: supabase/setup-cli@v1
with:
version: 1.0.0
Run supabase start to execute all migrations on a fresh database:
steps:
- uses: supabase/setup-cli@v1
with:
version: 1.0.0
- run: supabase init
- run: supabase 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 ofsupabaseto install, defaulting to1.0.0
Advanced Usage
Check generated TypeScript types are up-to-date with Postgres schema:
steps:
- uses: supabase/setup-cli@v1
- run: supabase init
- run: supabase start
- name: Verify generated types match Postgres schema
run: |
supabase gen types typescript --local > schema.gen.ts
if [ "$(git diff --ignore-space-at-eol schema.gen.ts | wc -l)" -gt "0" ]; 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:
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
Requires
node >= 16
Install the dependencies
$ npm install
Build the typescript and package it for distribution
$ npm run build && npm run package
Run the tests
$ 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.
Then run ncc and push the results:
$ 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!
See the versioning documentation
Validate
You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)
uses: ./
with:
version: 1.0.0
See the actions tab for runs of this action!
32 Dec 26, 2022
2 Oct 21, 2022
14.7k Dec 29, 2022
3.6k Dec 30, 2022
3.8k Jan 7, 2023
3.5k Dec 30, 2022
619 Dec 26, 2022
343 Dec 1, 2022
422 Nov 19, 2022
262 Nov 21, 2022
207 Dec 30, 2022
8k Jan 4, 2023
7 Jun 6, 2021
21 Dec 13, 2022
26 Jan 10, 2022
1 Dec 25, 2021
34 Jan 3, 2023
9 Nov 17, 2022