Add broken link checker #958
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,57 @@ | ||
| name: Weekly Broken Link Check | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 2 * * MON" | ||
| timezone: "America/Los_Angeles" | ||
|
|
||
| jobs: | ||
| linkchecker: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| permissions: | ||
| issues: write | ||
|
|
||
| steps: | ||
| - name: Check out | ||
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # 7.0.1 | ||
| with: | ||
| persist-credentials: false # since the next step does not need it | ||
|
|
||
| - name: Install dependencies | ||
| run: pip install linkchecker beautifulsoup4 | ||
|
|
||
| - name: Run linkchecker | ||
| id: linkchecker | ||
| run: linkchecker --config=linkcheckerrc --check-extern --file-output=html/utf-8/results.html https://www.camobilitymarketplace.org | ||
|
|
||
| - name: Strip all but body contents | ||
| id: extract-report-body | ||
| if: ${{ failure() }} | ||
| run: python3 -c 'from bs4 import BeautifulSoup; print(BeautifulSoup(open("results.html").read(), "html.parser").body.decode_contents())' > report_body.html | ||
|
|
||
| - name: Check for an open linkchecker issue | ||
| id: open-issue-check | ||
| if: ${{ failure() }} | ||
| run: echo "OPEN_ISSUE_ID=`gh issue list --label linkchecker --json number --jq '.[0].number'`" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Add content to existing issue | ||
| if: ${{ failure() && steps.open-issue-check.outputs.OPEN_ISSUE_ID != '' }} | ||
| run: | | ||
| echo -e "## Updated broken link report\n\nFrom weekly run: https://github.com/cal-itp/mobility-marketplace/actions/runs/${{ github.run_id }}\n\n<details>\n" > comment.md | ||
| cat report_body.html >> comment.md | ||
| echo -e "\n</details>" >> comment.md | ||
| gh issue comment ${{ steps.open-issue-check.outputs.OPEN_ISSUE_ID }} \ | ||
| --body-file comment.md | ||
|
|
||
| - name: Create new issue | ||
| if: ${{ failure() && steps.open-issue-check.outputs.OPEN_ISSUE_ID == '' }} | ||
| run: | | ||
| echo -e "## Broken link report\n\nDiscovered during weekly run: https://github.com/cal-itp/mobility-marketplace/actions/runs/${{ github.run_id }}\n\n<details>\n" > comment.md | ||
| cat report_body.html >> comment.md | ||
| echo -e "\n</details>" >> comment.md | ||
| gh issue create \ | ||
| --title "Broken links found" \ | ||
| --body-file comment.md \ | ||
| --label "content,bug,linkchecker" | ||
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,6 @@ | ||
| [filtering] | ||
| ignore= | ||
| /cdn-cgi/l/email-protection | ||
|
Comment on lines
+2
to
+3
Member
There was a problem hiding this comment. what are these links pray tell?
Member
Author
There was a problem hiding this comment. Turns out that we have Cloudflare set up to mask email addresses, so the <a href="/cdn-cgi/l/email-protection#79111c151516391a1815100d0957160b1e">
<span class="__cf_email__" data-cfemail="670f020b0b082704060b0e131749081500">[email protected]</span>
</a>And those result in 404s if it just tries to follow them directly. |
||
| ignorewarnings=http-redirected | ||
|
|
||
| [AnchorCheck] | ||
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.
i dig that you're just using
ghfor all this.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.
It's a pretty powerful addition to the built-in GHA toolset!