|
| 1 | +name: 🍈 Lychee |
| 2 | + |
| 3 | +on: [pull_request] |
| 4 | + |
| 5 | +concurrency: |
| 6 | + group: lychee-${{ github.event.pull_request.number }} |
| 7 | + cancel-in-progress: true |
| 8 | + |
| 9 | +jobs: |
| 10 | + check-links: |
| 11 | + name: Check links |
| 12 | + runs-on: ubuntu-latest |
| 13 | + permissions: |
| 14 | + pull-requests: write |
| 15 | + steps: |
| 16 | + - uses: actions/checkout@v4 |
| 17 | + |
| 18 | + - name: 🍈 Lychee Link Checker (First Run) |
| 19 | + id: lychee |
| 20 | + uses: lycheeverse/lychee-action@v2 |
| 21 | + with: |
| 22 | + fail: false |
| 23 | + output: ../lychee/out.md |
| 24 | + args: > |
| 25 | + --cache |
| 26 | + --cache-exclude-status 429,500,502,503,504 |
| 27 | + --max-cache-age 5m |
| 28 | + --verbose |
| 29 | + --no-progress |
| 30 | + --accept 200,201,204,304,403,429 |
| 31 | + --timeout 20 |
| 32 | + --max-retries 8 |
| 33 | + --retry-wait-time 5 |
| 34 | + --exclude 'http://localhost.*' |
| 35 | + --exclude 'https://localhost.*' |
| 36 | + --exclude 'https://cockroachlabs.com' |
| 37 | + --exclude '^/.*' |
| 38 | + './**/*.md' './**/*.mdx' |
| 39 | + workingDirectory: "content" |
| 40 | + env: |
| 41 | + GITHUB_TOKEN: ${{ secrets.github_token }} |
| 42 | + |
| 43 | + - name: 🔄 Retry Lychee Link Checker (Second Run for Timeouts) |
| 44 | + id: lychee-retry |
| 45 | + if: ${{ always() && steps.lychee.outputs.exit_code != 0 }} |
| 46 | + uses: lycheeverse/lychee-action@v2 |
| 47 | + with: |
| 48 | + fail: false |
| 49 | + output: ../lychee/out-retry.md |
| 50 | + args: > |
| 51 | + --cache |
| 52 | + --max-cache-age 5m |
| 53 | + --verbose |
| 54 | + --no-progress |
| 55 | + --accept 200,201,204,304,403,429 |
| 56 | + --cache-exclude-status 429,500,502,503,504 |
| 57 | + --timeout 30 |
| 58 | + --max-retries 10 |
| 59 | + --retry-wait-time 10 |
| 60 | + --exclude 'http://localhost.*' |
| 61 | + --exclude 'https://localhost.*' |
| 62 | + --exclude 'https://cockroachlabs.com' |
| 63 | + --exclude '^/.*' |
| 64 | + './**/*.md' './**/*.mdx' |
| 65 | + workingDirectory: "content" |
| 66 | + env: |
| 67 | + GITHUB_TOKEN: ${{ secrets.github_token }} |
| 68 | + |
| 69 | + - name: 📝 Clean up Lychee Report |
| 70 | + if: ${{ always() && github.event.pull_request.head.repo.fork == false }} |
| 71 | + run: | |
| 72 | + # Use retry results if available, otherwise use first run results |
| 73 | + if [ -f "lychee/out-retry.md" ]; then |
| 74 | + REPORT_FILE="lychee/out-retry.md" |
| 75 | + NOTE="Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout." |
| 76 | + elif [ -f "lychee/out.md" ]; then |
| 77 | + REPORT_FILE="lychee/out.md" |
| 78 | + NOTE="Links are cached for 5 minutes to avoid unnecessary requests, and speed up consecutive runs." |
| 79 | + fi |
| 80 | +
|
| 81 | + if [ -n "$REPORT_FILE" ]; then |
| 82 | + # Read the original output |
| 83 | + ORIGINAL=$(cat "$REPORT_FILE") |
| 84 | +
|
| 85 | + # Create formatted output |
| 86 | + cat > lychee/formatted.md << EOF |
| 87 | + ## 🍈 Lychee Link Check Report |
| 88 | +
|
| 89 | + > **Note:** $NOTE |
| 90 | +
|
| 91 | + ### 📊 Results Overview |
| 92 | +
|
| 93 | + EOF |
| 94 | +
|
| 95 | + # Append the original content with title replacement |
| 96 | + echo "$ORIGINAL" | sed 's/^# Summary$//' | sed 's/^## Summary$//' >> lychee/formatted.md |
| 97 | + fi |
| 98 | +
|
| 99 | + - name: 📝 Comment Broken Links |
| 100 | + if: ${{ always() && github.event.pull_request.head.repo.fork == false }} |
| 101 | + uses: peter-evans/create-or-update-comment@v4 |
| 102 | + with: |
| 103 | + issue-number: ${{ github.event.pull_request.number }} |
| 104 | + body-path: lychee/formatted.md |
| 105 | + |
| 106 | + - name: 🚫 Fail if broken links found |
| 107 | + if: ${{ steps.lychee-retry.conclusion == 'success' && steps.lychee-retry.outputs.exit_code != 0 || steps.lychee-retry.conclusion == 'failure' }} |
| 108 | + run: | |
| 109 | + if [ "${{ steps.lychee-retry.conclusion }}" == "success" ]; then |
| 110 | + echo "Failing based on retry run results" |
| 111 | + exit ${{ steps.lychee-retry.outputs.exit_code }} |
| 112 | + else |
| 113 | + echo "Failing based on first run results" |
| 114 | + exit ${{ steps.lychee.outputs.exit_code }} |
| 115 | + fi |
0 commit comments