Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/validate-sidebar-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Validate Sidebar Links
run-name: Validating sidebar links

on:
pull_request:
branches:
- master
paths:
- 'sidebars.js'
- 'sdk-sidebar.js'
- 'docs/**/*.md'
- 'docs/**/*.mdx'
- 'scripts/check-sidebar-links.ts'
- '.github/workflows/validate-sidebar-links.yml'
push:
branches:
- master
paths:
- 'sidebars.js'
- 'sdk-sidebar.js'

jobs:
validate-sidebar-links:
name: 'Validate Sidebar Links'
runs-on: ubuntu-latest
steps:
- name: Checkout files
uses: actions/checkout@v4
with:
# Shallow clone is fine, we only need current state
fetch-depth: 1

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '22.x'

- name: Install node_modules
uses: OffchainLabs/actions/node-modules/install@main
with:
install-command: yarn install --frozen-lockfile

- name: Validate sidebar links
run: yarn tsx scripts/check-sidebar-links.ts
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"typecheck": "tsc",
"check-releases": "ts-node scripts/check-releases.ts",
"check-markdown": "tsx scripts/check-markdown.ts",
"check-sidebar-links": "tsx scripts/check-sidebar-links.ts",
"notion:update": "tsx scripts/notion-update.ts",
"notion:verify-quicklooks": "tsx scripts/notion-verify-quicklooks.ts",
"lint:markdown": "markdownlint \"docs/**/*.{md,mdx}\" --ignore \"docs/sdk/**\"",
Expand Down
Loading
Loading