supabase/setup-cli
1
0
Fork 0
mirror of https://github.com/supabase/setup-cli.git synced 2026-02-09 11:51:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: migrate to esm (#334)

Browse Source 
* chore: update unit tests

* fix: follow latest action template

* chore: add licenses and workflows

* chore: remove bloat

* chore: fix linter
This commit is contained in:
Han Qiao
2025-07-23 15:04:43 +08:00
committed by GitHub
parent 6c3c96bfbe
commit b60b5899c7
48 changed files with 40108 additions and 32534 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/index.md
View File

@@ -1,16 +1,22 @@
# `supabase-github-action`
The Supabase GitHub Action provides an easy way to use the Supabase CLI on GitHub's hosted Actions runners.
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.
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.
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`.
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:
Copy this snippet inside the file, and the action will run whenever a new PR is
created:
```yaml
name: 'test-migrations'
@@ -18,7 +24,7 @@ on:
pull_request:
jobs:
build:
build:
runs-on: ubuntu-latest
steps:
- uses: supabase/setup-cli@v1
@@ -28,8 +34,9 @@ jobs:
- 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>
- **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>