This action makes it easy to quickly write a script in your workflow that uses the Supabase Management API and the workflow run context.
To use this action, provide an input named script that contains the body of an asynchronous function call. The following arguments will be provided:
supabaseManagerA pre-authenticated SupabaseManager client for the Supabase Management API.contextAn object containing the context of the workflow runcoreA reference to the @actions/core package
Since the script is just a function body, these values will already be
defined, so you don't have to import them (see examples below).
Find out more about Supabase Branching by reading the official docs here.
This action is a wrapper around the Supabase Management API.
Not officially endorsed by Supabase.
Basic usage:
- name: Get Supabase Database Branch
uses: 0xbigboss/supabase-branch-gh-action@v1
id: supabase-branch
with:
supabase-access-token: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
supabase-project-id: ${{ secrets.SUPABASE_PROJECT_ID }} # use the parent project id
- name: Add SMS provider to Supabase branch
uses: 0xbigboss/supabase-manager-script-gh-action@v1
id: add-sms-provider
with:
supabase-access-token: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
script: |
const parentAuthConfig = await supabaseManager.projectsConfig.getV1AuthConfig({
ref: process.env.SUPABASE_PARENT_PROJECT_ID,
});
await supabaseManager.projectsConfig.updateV1AuthConfig({
ref: process.env.SUPABASE_PROJECT_ID,
requestBody: {
external_phone_enabled: true,
sms_provider: parentAuthConfig.sms_provider,
sms_twilio_verify_account_sid:
parentAuthConfig.sms_twilio_verify_account_sid,
sms_twilio_verify_auth_token: parentAuthConfig.sms_twilio_verify_auth_token,
sms_twilio_verify_message_service_sid:
parentAuthConfig.sms_twilio_verify_message_service_sid,
},
});
return "success";
env:
SUPABASE_PROJECT_ID: ${{ steps.supabase-branch.outputs.project_ref }}
SUPABASE_PARENT_PROJECT_ID: ${{ steps.supabase-branch.outputs.parent_project_ref }}
- name: Get result
run: echo "${{steps.supabase-script.outputs.result}}"By default, the JSON-encoded return value of the function is set as the "result" in the
output of a github-script step. For some workflows, string encoding is preferred. This option can be set using the
result-encoding input:
- uses: 0xbigboss/supabase-manager-script-gh-action@v1
id: my-script
with:
result-encoding: string
script: return "I will be string (not JSON) encoded!"To install dependencies:
bun installMake some changes and then run:
bun run buildCommit the changes and push!
You can mock the action environment by running it like so:
process.env[
`INPUT_${"supabase-access-token".replace(/ /g, "_").toUpperCase()}`
] = process.env.SUPABASE_ACCESS_TOKEN;
process.env[`INPUT_${"supabase-project-id".replace(/ /g, "_").toUpperCase()}`] =
process.env.SUPABASE_PROJECT_ID;
process.env[`INPUT_${"wait-for-migrations".replace(/ /g, "_").toUpperCase()}`] =
"false";
process.env[`INPUT_${"timeout".replace(/ /g, "_").toUpperCase()}`] = "60";
await main();This project was created using bun init in bun v1.0.29. Bun is a fast all-in-one JavaScript runtime.