Skip to content

refactor(plugins): extract the provider plugins into a private package #456

refactor(plugins): extract the provider plugins into a private package

refactor(plugins): extract the provider plugins into a private package #456

Workflow file for this run

name: Docs
# ci.yml ignores docs paths, so docs-only PRs need their own lane. The links
# gate builds the site and checks the rendered pages, so the rspress version
# (website/package.json, the lockfile) and config re-run it as well.
on:
pull_request:
paths:
- 'website/docs/**'
- 'website/package.json'
- 'website/rspress.config.ts'
- 'README.md'
- 'scripts/check-doc-links.ts'
- 'scripts/__tests__/check-doc-links.test.ts'
- 'scripts/check-doc-prose.ts'
- 'scripts/__tests__/check-doc-prose.test.ts'
- 'scripts/check-affected/**'
- 'package.json'
- 'pnpm-lock.yaml'
- '.github/actions/run-gate/action.yml'
- '.github/actions/setup-node-pnpm/action.yml'
- '.github/workflows/docs.yml'
push:
branches:
- main
paths:
- 'website/docs/**'
- 'website/package.json'
- 'website/rspress.config.ts'
- 'README.md'
- 'scripts/check-doc-links.ts'
- 'scripts/__tests__/check-doc-links.test.ts'
- 'scripts/check-doc-prose.ts'
- 'scripts/__tests__/check-doc-prose.test.ts'
- 'scripts/check-affected/**'
- 'package.json'
- 'pnpm-lock.yaml'
- '.github/actions/run-gate/action.yml'
- '.github/actions/setup-node-pnpm/action.yml'
- '.github/workflows/docs.yml'
permissions:
contents: read
concurrency:
group: >-
ci-${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.ref || github.sha }}
cancel-in-progress: true
jobs:
check:
name: Prose, internal links, and heading anchors
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Setup Node and pnpm
uses: ./.github/actions/setup-node-pnpm
# Reads the Markdown sources only, so it fails before the site build.
- name: Check docs prose
uses: ./.github/actions/run-gate
with: { gate: docs-prose }
# Builds the site (root install covers the website workspace), then checks it.
- name: Check docs links
uses: ./.github/actions/run-gate
with: { gate: docs-links }