Skip to content

chore: replace broken-link-checker with linkinator#788

Open
mcdurdin wants to merge 1 commit into
chore/use-common-function-for-http-requestsfrom
chore/linkinator
Open

chore: replace broken-link-checker with linkinator#788
mcdurdin wants to merge 1 commit into
chore/use-common-function-for-http-requestsfrom
chore/linkinator

Conversation

@mcdurdin

@mcdurdin mcdurdin commented Jun 12, 2026

Copy link
Copy Markdown
Member

Broken-link-checker (BLC) is basically dead -- no releases for 8 years, no updates to master for 5. The trigger for this change is, however, that BLC was not honoring exclusions on redirects, which cause sporadic errors (e.g. 429) because we hit external servers in our link test.

Replace with linkinator, which is in maintenance and does the job pretty well.

I have forked linkinator and added some patches specific to our environment which I may push upstream later when we are confident of the setup:

Unify the ci.yml and build.sh test steps.

I have compared the crawl results and they appear to be essentially identical (differences in reporting on redirects means a 1:1 comparison is not possible).

Test-bot: skip

@keymanapp-test-bot

Copy link
Copy Markdown

User Test Results

Test specification and instructions

User tests are not required

@keymanapp-test-bot keymanapp-test-bot Bot added this to the A19S31 milestone Jun 12, 2026
@github-actions github-actions Bot added the chore label Jun 12, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Keyman Jun 12, 2026
@mcdurdin mcdurdin force-pushed the chore/linkinator branch 2 times, most recently from 2a8334f to b5f9cfc Compare June 12, 2026 14:05
@mcdurdin mcdurdin force-pushed the chore/use-common-function-for-http-requests branch from 0b9e537 to ece6d4f Compare June 12, 2026 15:01
@mcdurdin mcdurdin requested a review from ermshiperete June 12, 2026 15:12
@mcdurdin mcdurdin force-pushed the chore/linkinator branch 7 times, most recently from 5dd53bf to 3317ea7 Compare June 15, 2026 07:47
mcdurdin added a commit to keymanapp/help.keyman.com that referenced this pull request Jun 15, 2026
mcdurdin added a commit to keymanapp/shared-sites that referenced this pull request Jun 15, 2026
mcdurdin added a commit to keymanapp/help.keyman.com that referenced this pull request Jun 15, 2026
mcdurdin added a commit to keymanapp/keymanweb.com that referenced this pull request Jun 15, 2026
mcdurdin added a commit to keymanapp/shared-sites that referenced this pull request Jun 15, 2026
Broken-link-checker (BLC) is basically dead -- no releases for 8 years,
no updates to master for 5. The trigger for this change is, however,
that BLC was not honoring exclusions on redirects, which cause sporadic
errors (e.g. 429) because we hit external servers in our link test.

Replace with linkinator, which is in maintenance and does the job
pretty well.

I have forked linkinator and added some patches specific to our
environment which I may push upstream later when we are confident of the
setup.

Unify the ci.yml and build.sh test steps (this will need to be tested
in CI once this merges to master).

Test-bot: skip
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants