mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
Wen Bo Xie
2681a21f5c
Add a guide that compares classic and scoped personal access tokens, explains how account roles constrain token permissions, and walks through creating and testing a project-scoped token. Include generated tables mapping permissions to Management API endpoints and MCP tools, and link the guide from docs navigation and Studio token sheets. Move the scoped-token permission catalog from Studio into shared-data. Studio and docs generation now share permission names, categories, descriptions, risk metadata, modes, scopes, and display order. Generate the tables from the shared catalog, OpenAPI x-fga-permissions, and the downloaded MCP permission map. Exclude Workers permissions until the feature is live. Run regeneration through the docs Makefile, verify checked-in output in CI, and refresh it in the weekly Management API workflow. Add Dashboard and Docs ownership plus contributor guidance so permission changes stay synchronized.
76 lines
2.4 KiB
YAML
76 lines
2.4 KiB
YAML
name: Update Mgmt Api Docs
|
|
|
|
on:
|
|
schedule:
|
|
# Run at 00:00 UTC every Monday
|
|
- cron: '0 0 * * 1'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
pull-requests: write
|
|
contents: write
|
|
|
|
jobs:
|
|
update-docs:
|
|
runs-on: blacksmith-4vcpu-ubuntu-2404
|
|
|
|
steps:
|
|
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
|
with:
|
|
persist-credentials: false
|
|
ref: ${{ github.ref }}
|
|
# The PAT tables generator imports the shared catalog and its base tsconfig.
|
|
sparse-checkout: |
|
|
apps/docs
|
|
patches
|
|
packages/generator
|
|
packages/shared-data
|
|
packages/tsconfig
|
|
|
|
- uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
|
|
name: Install pnpm
|
|
with:
|
|
run_install: false
|
|
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
cache: 'pnpm'
|
|
|
|
- name: Install deps
|
|
run: pnpm install --frozen-lockfile
|
|
|
|
- name: Refresh Management API docs
|
|
working-directory: apps/docs/spec
|
|
run: make download.api.v1 download.mcp-tools-permissions dereference.api.v1 generate.sections.api.v1 generate.partials.access-control format
|
|
|
|
- name: Generate token
|
|
id: app-token
|
|
uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
|
|
with:
|
|
client-id: ${{ vars.GH_AUTOFIX_APP_CLIENT_ID }}
|
|
private-key: ${{ secrets.GH_AUTOFIX_PRIVATE_KEY }}
|
|
permission-pull-requests: write
|
|
permission-contents: write
|
|
|
|
- name: Create pull request
|
|
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0
|
|
with:
|
|
token: ${{ steps.app-token.outputs.token }}
|
|
commit-message: 'feat: update mgmt api docs'
|
|
title: 'feat: update mgmt api docs'
|
|
body: |
|
|
This PR updates Management API docs automatically.
|
|
|
|
This regenerates:
|
|
|
|
- Management API specs and sections
|
|
- Personal Access Tokens permission-to-endpoint table
|
|
- Personal Access Tokens MCP tool permissions table
|
|
|
|
Sources include the live Management API specs, MCP permission map,
|
|
and Studio's shared permission catalog.
|
|
branch: 'gha/auto-update-mgmt-api-docs'
|
|
base: 'master'
|