https://github.com/lyqht/generate-supabase-db-types-github-action

GitHub Action to generate Supabase Database Types
https://github.com/lyqht/generate-supabase-db-types-github-action

github-actions hacktoberfest

Last synced: about 2 months ago
JSON representation

GitHub Action to generate Supabase Database Types

• Host: GitHub
• URL: https://github.com/lyqht/generate-supabase-db-types-github-action
• Owner: lyqht
• License: mit
• Created: 2022-04-11T13:47:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-29T14:42:30.000Z (about 1 year ago)
• Last Synced: 2024-05-05T22:22:02.253Z (about 2 months ago)
• Topics: github-actions, hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 828 KB
• Stars: 40
• Watchers: 1
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-supabase - Generate Supabase Database Types GitHub Action - GitHub action to generate types based on your Supabase database. (Community Tools)

README

        
# GitHub action to generate Supabase Database types

This GitHub action workflow aims to help you to create a Supabase database definition types file in your project.

## What it does

This workflow is a composite action:

- Generate database types with a built in command from [supabase/setup-cli](https://github.com/supabase/setup-cli).

- Commit and push github actions to your repo are performed by the [git-auto-commit action](https://github.com/stefanzweifel/git-auto-commit-action).

- Creating the pull request is performed by [pull-request action](https://github.com/repo-sync/pull-request).

## How to use

If you don't have an existing GitHub Action workflow for your repository

1. Create a folder `.github/workflows` if you don't have it already 

2. Inside that folder, create a YAML file say `update-types.yml`

3. In the `update-types.yml` file, you can copy the example below and modify it to your usage.

4. You can choose to declare the `schedule` with a cron expression to run the job at a specified frequency e.g. every day once.

How to get Supabase Access Token

Go to https://app.supabase.com/account/tokens and get a token there.

![](access_token_preview.png)

Otherwise, you can get started by referring to to the example given and the input options available.

### Simple Example

```yml

name: Update database types

on:

  schedule:

    - cron: '*/60 * * * *'

  workflow_dispatch:

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - uses: lyqht/generate-supabase-db-types-github-action@main

      with:

        SUPABASE_REF_ID: ${{ secrets.SUPABASE_REF_ID }}

        SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}

        DB_PASSWORD: ${{ secrets.DB_PASSWORD }}

        OUTPUT_PATH: db.types.ts

```

### Example based on migration scripts

If your DB schema is kept up to date based on the migration SQL scripts within your project itself, you can configure the workflow to run based on any new SQL files pushed to your branch.

```yml

name: Update database types

on:

  push:

    branches: [ main ]

    paths:

      - '*.sql'

jobs:

  build:

    runs-on: ubuntu-latest

    if: github.head_ref != 'supabot**'

    steps:

    - uses: lyqht/generate-supabase-db-types-github-action@main

      with:

        SUPABASE_REF_ID: ${{ secrets.SUPABASE_REF_ID }}

        SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}

        DB_PASSWORD: ${{ secrets.DB_PASSWORD }}

        OUTPUT_PATH: db.types.ts

```

## Migrating from `v0.1.0` to `v1.0.0`

Please note that this will be a breaking change. The types generated from v0.1.0 could be different from that of v1.0.0, so you may need to modify your code quite a bit if you choose to migrate for fields of data types such as `JSON`, `Date`. However, `v1.0.0` types follows what supabase recommends.

### Why and how the types are different?

> 🔖 Here's an [article](https://blog.esteetey.dev/how-to-create-and-test-a-github-action-that-generates-types-from-supabase-database#heading-how-to-create-the-github-workflow) that explains more in-depth the rationale & implementation of v0.1.0 of this GitHub action.

v0.1.0 relies on the `openapi-typescript` library to generate types based on the OpenAPI specs that the Supabase endpoint offers.

v1.0.0 relies on `supabase-cli` to generate the types using supabase, and these types are much more compatible to the `supabasejs-v2` library.

- Types generated by v0.1.0: [Example](./exampleV010.ts)

- Types generated by v1.0.0: [Example](./exampleV100.ts)

### Changes to make

You need to make the following changes in variables:

- No longer used: `SUPABASE_URL: ${{secrets.SUPABASE_URL }}` and `SUPABASE_ANON_KEY: ${{ secrets.SUPABASE_ANON_KEY }}`

- You have to add `SUPABASE_REF_ID: ${{ secrets.SUPABASE_REF_ID }}`, and `SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}`

## Cavaets

> Note that if your Supabase project is paused or deleted, this bot will only result in failed jobs.