brainglobe / brainglobe/brainglobe.github.io

[Feature] Moving linkcheck to a cron job

Open
#524 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
14
Forks
32
Avg merge
1d 22m
Merged PRs (30d)
9

Description

**Is your feature request related to a problem? Please describe.**
Occasionally, sporadic `linkcheck` failures slow down the process of merging PRs, or cause deployment failures following PR merges.

**Describe the solution you'd like**
Perhaps we could run `linkcheck` on the full website as a scheduled job (once a week) and notify the developers of the broken links for manual verification. The PR `linkcheck` would only check new links that were added (if that's possible to set up).

**Describe alternatives you've considered**
- Adding sporadically failing links to `linkcheck` doesn't scale well

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the current PR linkcheck and deployment-check configuration, then determine how a weekly full-site run, a check limited to newly added links, and developer notifications should fit together. Done means the scheduled check reports broken links without blocking unrelated PR merges or deployments.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.