style: implement markdown linting with remark #166
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Validate Docs on PR | |
on: | |
pull_request: | |
branches: [main] | |
jobs: | |
open-api-specs: | |
name: OpenAPI Specs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup pnpm | |
uses: ./.github/actions/setup-pnpm | |
- name: Validate REST API specs | |
run: pnpm run generate:rest | |
rpc-specs: | |
name: JSON-RPC Specs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup pnpm | |
uses: ./.github/actions/setup-pnpm | |
- name: Validate RPC specs | |
run: pnpm run generate:rpc | |
markdown-files: | |
name: Markdown Files | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup pnpm | |
uses: ./.github/actions/setup-pnpm | |
- name: Validate markdown files | |
run: pnpm run validate:mdx | |
fern-check: | |
name: Fern Check | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install Fern | |
run: npm install -g fern-api | |
- name: Check API is valid | |
run: fern check |