-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Adds automated job to check for broken links in documentation and fixes some links #3888
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kellyguo11
wants to merge
4
commits into
isaac-sim:main
Choose a base branch
from
kellyguo11:fix/broken-links
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+123
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Copyright (c) 2022-2025, The Isaac Lab Project Developers (https://github.com/isaac-sim/IsaacLab/blob/main/CONTRIBUTORS.md). | ||
| # All rights reserved. | ||
| # | ||
| # SPDX-License-Identifier: BSD-3-Clause | ||
|
|
||
| name: Check Documentation Links | ||
|
|
||
| on: | ||
| # Run on pull requests that modify documentation | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - '**.md' | ||
| - '.github/workflows/check-links.yml' | ||
| # Run on pushes to main branches | ||
| push: | ||
| branches: | ||
| - main | ||
| - devel | ||
| - 'release/**' | ||
| paths: | ||
| - 'docs/**' | ||
| - '**.md' | ||
| - '.github/workflows/check-links.yml' | ||
| # Allow manual trigger | ||
| workflow_dispatch: | ||
| # Run weekly to catch external links that break over time | ||
| schedule: | ||
| - cron: '0 0 * * 0' # Every Sunday at midnight UTC | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| check-links: | ||
| name: Check for Broken Links | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Restore lychee cache | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: .lycheecache | ||
| key: cache-lychee-${{ github.sha }} | ||
| restore-keys: cache-lychee- | ||
|
|
||
| - name: Run Link Checker | ||
| uses: lycheeverse/lychee-action@v2 | ||
| with: | ||
| # Check all markdown files and documentation | ||
| args: >- | ||
| --verbose | ||
| --no-progress | ||
| --cache | ||
| --max-cache-age 1d | ||
| --exclude-path './docs/_build' | ||
| --exclude-path './apps/warp-*' | ||
| --exclude-path './logs' | ||
| --exclude-path './outputs' | ||
| --exclude-loopback | ||
| --exclude '^file://' | ||
| --exclude '^mailto:' | ||
| --exclude 'localhost' | ||
| --exclude '127\.0\.0\.1' | ||
| --exclude 'example\.com' | ||
| --exclude 'your-organization' | ||
| --exclude 'YOUR_' | ||
| --exclude 'yourdomain' | ||
| --exclude 'user@' | ||
| --exclude 'helm\.ngc\.nvidia\.com' | ||
| --exclude 'slurm\.schedmd\.com' | ||
| --max-retries 3 | ||
| --retry-wait-time 5 | ||
| --timeout 30 | ||
| --accept 200,201,202,203,204,206,301,302,303,307,308,429 | ||
| --scheme https | ||
| --scheme http | ||
| '*.md' | ||
| '**/*.md' | ||
| 'docs/**/*.rst' | ||
| 'docs/**/*.html' | ||
| # Output results to a file | ||
| output: ./lychee-output.md | ||
| # Fail action on broken links | ||
| fail: true | ||
| # Optional: Use GitHub token for authenticated requests (higher rate limit) | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Print results to logs | ||
| if: always() | ||
| run: | | ||
| echo "========================================" | ||
| echo "Link Checker Results:" | ||
| echo "========================================" | ||
| if [ -f ./lychee-output.md ]; then | ||
| cat ./lychee-output.md | ||
| echo "" | ||
| echo "========================================" | ||
|
|
||
| # Also add to GitHub step summary for easy viewing | ||
| echo "## Link Checker Results" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| cat ./lychee-output.md >> $GITHUB_STEP_SUMMARY | ||
| else | ||
| echo "No output file generated" | ||
| echo "========================================" | ||
| fi | ||
|
|
||
| - name: Fail job if broken links found | ||
| if: failure() | ||
| run: | | ||
| echo "❌ Broken links were found in the documentation!" | ||
| echo "Please review the link checker report above and fix all broken links." | ||
| exit 1 | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: cache key uses SHA which creates unique cache for every commit, preventing reuse across PRs - consider including PR number or ref in key for better cache hits