Skip to content

chore: adopt shared oxlint config #3413

chore: adopt shared oxlint config

chore: adopt shared oxlint config #3413

Workflow file for this run

name: Deploy PR previews
on:
pull_request:
types:
- opened
- reopened
- synchronize
paths:
- 'website/**'
- '.github/actions/build-docs/action.yml'
- '.github/actions/setup-node-pnpm/action.yml'
- '.github/workflows/pr-preview.yml'
- 'package.json'
- 'pnpm-lock.yaml'
- 'pnpm-workspace.yaml'
concurrency: preview-${{ github.ref }}
jobs:
command-docs-gate:
# ci.yml ignores website/**, so a docs-only PR never triggers the unit lane
# that carries the command-reference coverage gate
# (src/__tests__/command-doc-coverage.test.ts). Run it here — where
# commands.md changes DO trigger a workflow — so documenting a retired
# command (or dropping a public command's docs) fails on docs-only PRs too.
# Unlike deploy-preview this has no fork guard: the gate is read-only and
# must run on fork docs PRs as well. Coordinates with the #1429 gate manifest.
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Setup toolchain
uses: ./.github/actions/setup-node-pnpm
- name: Check command reference doc coverage
uses: ./.github/actions/run-gate
with: { gate: command-docs }
deploy-preview:
if: github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
pages: write
steps:
- name: Checkout
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
with:
persist-credentials: true
- name: Build docs
uses: ./.github/actions/build-docs
with:
rspress-base: /${{ github.event.repository.name }}/pr-preview/pr-${{ github.event.number }}/
- name: Deploy preview
uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1.8.1
with:
source-dir: website/doc_build
preview-branch: gh-pages
qr-code: true