QuantEcon / QuantEcon/lecture-python.myst

linkcheck: upgrade to QuantEcon/action-link-checker (preserve #906/#933 tuning)

Open
#954 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
123
Forks
57
Avg merge
3d 10h
Merged PRs (30d)
11

Description

Background

As part of the artifact-based GitHub Pages migration (#953, tracked in QuantEcon/meta#282), linkcheck.yml was moved off the gh-pages branch checkout to download+extract the latest release .tar.gz into _site. During that migration we kept the existing lycheeverse/lychee-action engine rather than switching to QuantEcon/action-link-checker@main (as lecture-python-intro / lecture-python-programming use).

Why we kept lychee for now

This repo's linkcheck has tuned false-positive suppression tied to resolved issues:

  • --accept 202 — IEEE Xplore anti-bot "202 Accepted" (#906)
  • --exclude-path for genindex / search / prf-prf auto-generated pages (#933)
  • --exclude for the Journal of Derivatives DOI redirect loop (#933)

QuantEcon/action-link-checker exposes silent-codes but no direct equivalent for --exclude-path or a specific-URL --exclude, so a naive swap risks regressing #906 / #933.

Task

Upgrade linkcheck.yml to QuantEcon/action-link-checker for family consistency, without reintroducing the #906 / #933 false positives — i.e. first confirm the action supports (or add support for) path excludes and a URL-level exclude, then port the tuning and verify a clean run.

Related: QuantEcon/meta#282, #906, #933.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with linkcheck.yml and compare its current lychee tuning with QuantEcon/action-link-checker documentation and implementation. Confirm or add support for path exclusions and the Journal of Derivatives URL exclusion while preserving the IEEE Xplore 202 handling and the #933 exclusions. Run the link-check workflow and consider the work done when it completes cleanly without those false positives.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, yaml
Domain
ci-cd
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.