Skip to content

Harden linkcheck.yml, declare known false positives, and pin the action to v1 #592

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.

Sign up for GitHub

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
mmcky merged 2 commits into from
Aug 3, 2026
+29 −5
Merged

Harden linkcheck.yml, declare known false positives, and pin the action to v1 #592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ddce37
Harden linkcheck.yml, declare known false positives, pin to v1
mmcky Aug 3, 2026
f8cc8d8
Note that Sphinx anchors these patterns and this checker does not
mmcky Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions .github/workflows/linkcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ jobs:
name: QuantEcon AI link checking
runs-on: "ubuntu-latest"
permissions:
contents: read # read latest release assets via gh api
issues: write # required for QuantEcon link-checker
steps:
# Download the latest release HTML archive (permanent, not subject to artifact expiry)
Expand All @@ -17,19 +18,42 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
run: |
set -euo pipefail
ASSET_URL=$(gh api repos/${{ github.repository }}/releases/latest \
--jq '.assets[] | select(.name | endswith(".tar.gz")) | .browser_download_url')
echo "asset-url=$ASSET_URL" >> $GITHUB_OUTPUT
--jq '[.assets[] | select(.name | endswith(".tar.gz")) | .browser_download_url] | first // ""')
if [ -z "$ASSET_URL" ]; then
echo "::error::No .tar.gz asset found on the latest release"
exit 1
fi
echo "asset-url=$ASSET_URL" >> "$GITHUB_OUTPUT"
- name: Download and extract release HTML
run: |
set -euo pipefail
mkdir -p _site
curl -sL "${{ steps.release.outputs.asset-url }}" | tar -xz -C _site
curl -fsSL "${{ steps.release.outputs.asset-url }}" | tar -xz -C _site
- name: AI-Powered Link Checker
uses: QuantEcon/action-link-checker@main
uses: QuantEcon/action-link-checker@v1
with:
html-path: '_site'
fail-on-broken: 'false'
silent-codes: '403,503'
ai-suggestions: 'true'
create-issue: 'true'

# Known false positives, kept in step with the linkcheck_ignore list in
# lectures/_config.yml. Sphinx's built-in checker reads that list; this
# checker scans the built HTML and never sees it, so the exemptions have
# to be stated in both places. Same regex syntax, so entries move across
# directly -- but the matching differs: Sphinx anchors a pattern at the
# start of the URL, this checker matches anywhere in it. A pattern
# copied here can therefore match more than it does there, never less.
# Update both when adding one, and anchor deliberately if it matters.
ignore-patterns: |
https://github.com/matplotlib/matplotlib/blob/v3.6.2/lib/matplotlib/axes/_axes.py#L1417-L1669
https://ieeexplore.ieee.org/document/8757088
https://www.sciencedirect.com/science/article/pii/S1477388021000177
https://keras.io/
https://data.oecd.org/
https://www.reddit.com/
https://openai.com
https://chatgpt.com/
https://fred.stlouisfed.org/.*
Loading