2022-03-16 13:58:53 +00:00
|
|
|
name: Docs
|
|
|
|
|
|
|
|
on:
|
|
|
|
push:
|
|
|
|
paths:
|
2022-10-17 10:10:05 +00:00
|
|
|
- "docs/**"
|
|
|
|
- ".github/workflows/docs.yml"
|
2023-06-27 11:27:11 +00:00
|
|
|
- "*.md"
|
2023-04-04 13:39:10 +00:00
|
|
|
# autofix workflow will be triggered instead for PRs
|
2022-03-16 13:58:53 +00:00
|
|
|
branches:
|
|
|
|
- main
|
2023-04-20 08:47:03 +00:00
|
|
|
- "!v[0-9]*"
|
2023-04-04 13:39:10 +00:00
|
|
|
|
|
|
|
# Remove default permissions of GITHUB_TOKEN for security
|
|
|
|
# https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
|
|
|
|
permissions: {}
|
2022-03-16 13:58:53 +00:00
|
|
|
|
|
|
|
jobs:
|
|
|
|
lint-docs:
|
2023-03-28 10:27:28 +00:00
|
|
|
runs-on: ubuntu-latest
|
2022-03-16 13:58:53 +00:00
|
|
|
|
|
|
|
steps:
|
2023-09-04 16:11:57 +00:00
|
|
|
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
|
2022-10-17 10:10:05 +00:00
|
|
|
- run: corepack enable
|
2023-08-18 15:05:38 +00:00
|
|
|
- uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
|
2022-03-16 13:58:53 +00:00
|
|
|
with:
|
2023-09-06 11:15:50 +00:00
|
|
|
node-version: 20.5
|
2022-10-17 10:10:05 +00:00
|
|
|
cache: "pnpm"
|
2022-03-16 13:58:53 +00:00
|
|
|
|
|
|
|
- name: Install dependencies
|
2022-10-17 10:10:05 +00:00
|
|
|
run: pnpm install
|
2022-03-16 13:58:53 +00:00
|
|
|
|
|
|
|
- name: Lint (docs)
|
2022-10-17 10:10:05 +00:00
|
|
|
run: pnpm lint:docs
|