-
Notifications
You must be signed in to change notification settings - Fork 1
Add GitHub Actions workflows for automated broken link detection #124
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5b24a6a
Initial plan
Copilot 1bb6149
Add GitHub Actions workflows for automated broken link checking
Copilot a5248c0
Fix code review issues: operator precedence, comment accuracy, and JS…
Copilot 5bf030a
Delete .github/workflows/README.md
ayush-shah 7a2d412
Address code review feedback: improve regex patterns, add .json suppo…
Copilot 5fcf12e
Address review feedback: upgrade to Node.js 20, improve error handlin…
Copilot 0f5eba7
Fix comment clarity and add safe array access with default value
Copilot 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
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,219 @@ | ||||||||
| name: Broken Links Check - Nightly | ||||||||
|
|
||||||||
| on: | ||||||||
| schedule: | ||||||||
| # Run every day at 2:00 AM UTC | ||||||||
| - cron: '0 2 * * *' | ||||||||
| workflow_dispatch: # Allow manual trigger | ||||||||
|
|
||||||||
| permissions: | ||||||||
| contents: read | ||||||||
|
|
||||||||
| jobs: | ||||||||
| check-broken-links: | ||||||||
| runs-on: ubuntu-latest | ||||||||
|
|
||||||||
| steps: | ||||||||
| - name: Checkout code | ||||||||
| uses: actions/checkout@v4 | ||||||||
|
|
||||||||
| - name: Setup Node.js | ||||||||
| uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20' | ||||||||
| cache: 'npm' | ||||||||
|
|
||||||||
| - name: Install dependencies | ||||||||
| run: | | ||||||||
| PUPPETEER_SKIP_DOWNLOAD=true npm install | ||||||||
| env: | ||||||||
| NODE_ENV: production | ||||||||
|
|
||||||||
| - name: Run broken links check | ||||||||
| id: broken_links | ||||||||
| run: | | ||||||||
| echo "Running broken links check..." | ||||||||
| OUTPUT=$(./node_modules/.bin/mint broken-links 2>&1) | ||||||||
| EXIT_CODE=$? | ||||||||
| echo "$OUTPUT" | ||||||||
|
|
||||||||
| # Save output to file | ||||||||
| echo "$OUTPUT" > broken-links-output.txt | ||||||||
|
|
||||||||
| # Check if the command failed for genuine errors | ||||||||
| # The mint broken-links command normally exits with 0 even when broken links are found | ||||||||
| if [ $EXIT_CODE -ne 0 ]; then | ||||||||
| echo "::error::Broken links check failed with exit code $EXIT_CODE" | ||||||||
| exit 1 | ||||||||
| fi | ||||||||
|
|
||||||||
| # Extract the summary line | ||||||||
| SUMMARY=$(echo "$OUTPUT" | grep -E "found [0-9]+ broken links" || echo "No broken links found") | ||||||||
| echo "summary=$SUMMARY" >> $GITHUB_OUTPUT | ||||||||
|
|
||||||||
| # Check if there are any broken links (non-zero count) | ||||||||
| if echo "$SUMMARY" | grep -qE "found [1-9][0-9]* broken links"; then | ||||||||
| echo "has_broken_links=true" >> $GITHUB_OUTPUT | ||||||||
| # Count total broken links | ||||||||
| TOTAL_LINKS=$(echo "$SUMMARY" | grep -oE "[0-9]+" | head -1) | ||||||||
| echo "total_links=$TOTAL_LINKS" >> $GITHUB_OUTPUT | ||||||||
| # Count files with broken links | ||||||||
| TOTAL_FILES=$(echo "$SUMMARY" | grep -oE "[0-9]+" | tail -1) | ||||||||
| echo "total_files=$TOTAL_FILES" >> $GITHUB_OUTPUT | ||||||||
| else | ||||||||
| echo "has_broken_links=false" >> $GITHUB_OUTPUT | ||||||||
| echo "total_links=0" >> $GITHUB_OUTPUT | ||||||||
| echo "total_files=0" >> $GITHUB_OUTPUT | ||||||||
| fi | ||||||||
|
|
||||||||
| - name: Prepare Slack message | ||||||||
| id: slack_message | ||||||||
| run: | | ||||||||
| OUTPUT_FILE="broken-links-output.txt" | ||||||||
| HAS_BROKEN_LINKS="${{ steps.broken_links.outputs.has_broken_links }}" | ||||||||
| SUMMARY="${{ steps.broken_links.outputs.summary }}" | ||||||||
| TOTAL_LINKS="${{ steps.broken_links.outputs.total_links }}" | ||||||||
| TOTAL_FILES="${{ steps.broken_links.outputs.total_files }}" | ||||||||
| REPO_URL="https://github.com/${{ github.repository }}" | ||||||||
|
|
||||||||
| if [ "$HAS_BROKEN_LINKS" = "true" ]; then | ||||||||
| # Create a truncated version of the output for Slack (first 100 lines) | ||||||||
| TRUNCATED_OUTPUT=$(head -100 "$OUTPUT_FILE") | ||||||||
|
|
||||||||
| # Add truncation note if output was truncated | ||||||||
| LINE_COUNT=$(wc -l < "$OUTPUT_FILE") | ||||||||
| if [ "$LINE_COUNT" -gt 100 ]; then | ||||||||
| TRUNCATED_OUTPUT="${TRUNCATED_OUTPUT}"$'\n\n'"[Output truncated to first 100 lines. See full report in workflow artifacts.]" | ||||||||
| fi | ||||||||
|
|
||||||||
| # Create JSON payload for Slack using jq for proper escaping | ||||||||
| jq -n \ | ||||||||
| --arg repo "${{ github.repository }}" \ | ||||||||
| --arg repo_url "$REPO_URL" \ | ||||||||
| --arg date "$(date -u +"%Y-%m-%d %H:%M UTC")" \ | ||||||||
| --arg total_links "$TOTAL_LINKS" \ | ||||||||
| --arg total_files "$TOTAL_FILES" \ | ||||||||
| --arg output "$TRUNCATED_OUTPUT" \ | ||||||||
| --arg run_url "$REPO_URL/actions/runs/${{ github.run_id }}" \ | ||||||||
| '{ | ||||||||
| "blocks": [ | ||||||||
| { | ||||||||
| "type": "header", | ||||||||
| "text": { | ||||||||
| "type": "plain_text", | ||||||||
| "text": "🔗 Broken Links Detection Report", | ||||||||
| "emoji": true | ||||||||
| } | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "fields": [ | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Repository:*\n<" + $repo_url + "|" + $repo + ">") | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Date:*\n" + $date) | ||||||||
| } | ||||||||
| ] | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "fields": [ | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Total Broken Links:*\n" + $total_links) | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Files Affected:*\n" + $total_files) | ||||||||
| } | ||||||||
| ] | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "divider" | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "text": { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Sample of Broken Links:*\n```" + $output + "```") | ||||||||
| } | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "text": { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("📄 *Full report is available in the <" + $run_url + "|GitHub Actions workflow run>*") | ||||||||
| } | ||||||||
| } | ||||||||
| ] | ||||||||
| }' > slack-payload.json | ||||||||
| else | ||||||||
| # Create success message for Slack using jq | ||||||||
| jq -n \ | ||||||||
| --arg repo "${{ github.repository }}" \ | ||||||||
| --arg repo_url "$REPO_URL" \ | ||||||||
| --arg date "$(date -u +"%Y-%m-%d %H:%M UTC")" \ | ||||||||
| '{ | ||||||||
| "blocks": [ | ||||||||
| { | ||||||||
| "type": "header", | ||||||||
| "text": { | ||||||||
| "type": "plain_text", | ||||||||
| "text": "✅ Broken Links Check Passed", | ||||||||
| "emoji": true | ||||||||
| } | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "fields": [ | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Repository:*\n<" + $repo_url + "|" + $repo + ">") | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": ("*Date:*\n" + $date) | ||||||||
| } | ||||||||
| ] | ||||||||
| }, | ||||||||
| { | ||||||||
| "type": "section", | ||||||||
| "text": { | ||||||||
| "type": "mrkdwn", | ||||||||
| "text": "No broken links detected in the documentation. 🎉" | ||||||||
| } | ||||||||
| } | ||||||||
| ] | ||||||||
| }' > slack-payload.json | ||||||||
| fi | ||||||||
|
|
||||||||
| cat slack-payload.json | ||||||||
|
|
||||||||
| - name: Send Slack notification | ||||||||
| if: always() | ||||||||
| env: | ||||||||
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} | ||||||||
| run: | | ||||||||
| if [ -z "$SLACK_WEBHOOK_URL" ]; then | ||||||||
|
||||||||
| if [ -z "$SLACK_WEBHOOK_URL" ]; then | |
| if [ -z "$SLACK_WEBHOOK_URL" ]; then | |
| echo "::warning::SLACK_WEBHOOK_URL not configured" |
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.
The truncation uses
head -100to limit output to 100 lines, but this may cut off a broken link entry in the middle, resulting in incomplete information in the Slack message. Consider adding logic to ensure truncation happens at a complete entry boundary, or add a note in the Slack message indicating that the output has been truncated (e.g., "Showing first 100 lines, see full report in artifacts").