Ci broken navbar links #3015
Closed
Ci broken navbar links #3015
Conversation
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
- Validates all sidebar reference types (doc, link, category, html, autogenerated) - Handles Docusaurus numbered prefixes for both files and directories - Skips validation for generated content (SDK docs, Stylus examples) - Provides clear error reporting with location information
- Triggers on PR and push to master when sidebar or docs change - Uses Node.js 22.x and existing CI patterns - Runs validation script with clear output - Fast execution without expensive SDK compilation
- Enables local validation with 'yarn check-sidebar-links' - Placed alongside other validation scripts
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The validate-sidebar-links workflow was failing because sdk-sidebar.js is a generated file (gitignored) that didn't exist in CI. The workflow now initializes submodules and generates SDK docs before running the link validation, matching the Vercel production build flow. Changes: - Enable recursive submodule checkout - Add step to install SDK dependencies - Add step to generate SDK docs via TypeDoc
The validate-sidebar-links workflow was failing because both sdk-sidebar.js and stylus-by-example sidebar files are generated (gitignored) and didn't exist in CI. The workflow now: 1. Initializes submodules (arbitrum-sdk, stylus-by-example) 2. Installs SDK dependencies 3. Syncs Stylus content to generate stylus-by-example sidebars 4. Generates SDK docs via TypeDoc to create sdk-sidebar.js 5. Validates sidebar links This matches the Vercel production build flow and ensures all required sidebar files exist before validation. Changes: - Enable recursive submodule checkout - Add step to install SDK dependencies - Add step to sync Stylus content - Add step to generate SDK docs via TypeDoc
Contributor
Author
|
Duplicate of 3041 |
Contributor
Author
|
Made redundant by: 3041 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds automated validation for
sidebars.jsto catch broken document references before they reach production.Changes
check-sidebar-links.ts): Validates all sidebar reference types (doc, link, category, html, autogenerated)01-,02-) and skips generated contentUsage