mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 10:25:06 +03:00
Katerina SkroumpelouandCharis Lam
b7f1616e3c
* chore: update docs from js monorepo * chore: remove sparse-checkout for workflow to work * chore: update workflow with no-frozen-lockfile * chore(js libs docs update): regenerate typespec snapshot on update * fix(typespec): fix missing types in transformed typespec --------- Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
75 lines
2.3 KiB
YAML
75 lines
2.3 KiB
YAML
name: Update JS Client Libraries Docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
version:
|
|
description: 'Version that was released (e.g., patch, minor, major, or v2.1.0)'
|
|
required: true
|
|
type: string
|
|
source:
|
|
description: 'Source of the documentation update'
|
|
required: false
|
|
type: string
|
|
default: 'manual'
|
|
|
|
permissions:
|
|
pull-requests: write
|
|
contents: write
|
|
|
|
jobs:
|
|
update-docs:
|
|
runs-on: blacksmith-4vcpu-ubuntu-2404
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
ref: master
|
|
|
|
- uses: pnpm/action-setup@v4
|
|
name: Install pnpm
|
|
with:
|
|
run_install: false
|
|
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
cache: 'pnpm'
|
|
|
|
- name: Install deps
|
|
run: pnpm i
|
|
|
|
- name: Regenerate JS client libraries tsdoc files
|
|
working-directory: apps/docs/spec
|
|
run: |
|
|
echo "Regenerating tsdoc files for JS client libraries..."
|
|
echo "Source: ${{ github.event.inputs.source }}"
|
|
echo "Version: ${{ github.event.inputs.version }}"
|
|
make
|
|
|
|
- name: Generate new typespec snapshot
|
|
working-directory: apps/docs
|
|
run: |
|
|
echo "Generating new typespec snapshot for review..."
|
|
npx vitest run --update ./features/docs/Reference.typeSpec.test.ts
|
|
|
|
- name: Create pull request
|
|
uses: peter-evans/create-pull-request@v6
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
commit-message: 'docs: update js client libraries (${{ github.event.inputs.version }})'
|
|
title: 'docs: update js client libraries (${{ github.event.inputs.version }})'
|
|
body: |
|
|
Updates JS client libraries documentation following stable release.
|
|
Ran `make` in apps/docs/spec to regenerate tsdoc files.
|
|
|
|
**Details:**
|
|
- **Version:** `${{ github.event.inputs.version }}`
|
|
- **Source:** `${{ github.event.inputs.source }}`
|
|
- **Changes:** Regenerated tsdoc files from latest spec files
|
|
|
|
🤖 Auto-generated from supabase-js-libs stable release.
|
|
branch: 'gha/update-js-libs-docs-${{ github.run_number }}'
|
|
base: 'master'
|