# Adapted from https://blog.somewhatabstract.com/2021/10/11/setting-up-dependabot-with-github-actions-to-approve-and-merge/
# Adapted from https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request
This action sets up the Supabase CLI, [`supabase`](https://github.com/supabase/cli), on GitHub's hosted Actions runners.
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.
@@ -24,7 +24,7 @@ A specific version of the `supabase` CLI can be installed:
steps:
- uses:supabase/setup-cli@v1
with:
version:1.28.3
version:1.136.3
```
Run `supabase db start` to execute all migrations on a fresh database:
@@ -44,9 +44,9 @@ Since Supabase CLI relies on Docker Engine API, additional setup may be required
The actions supports the following inputs:
| Name | Type | Description | Default | Required |
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)
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)
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/)
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
