ci(links-check): add external link checker using linkinator-action by umxr · Pull Request #6386 · fastify/fastify

umxr · 2025-11-10T19:53:12Z

Adds external link validation to spot dead links (status code != 200)
while keeping existing internal link checker.

Checklist

run npm run test && npm run benchmark --if-present
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

Adds external link validation to spot dead links (status code != 200) while keeping existing internal link checker. Fixes fastify#6385

.github/workflows/links-check.yml

Uzlopak

Well I checked the sourcecode of linikator and linkinator-action and it seems trustable.

.github/workflows/links-check.yml

jean-michelet · 2025-11-22T14:43:18Z

CI is green here while many broken links were found on #6394

mcollina

lgtm

gurgunday

lgtm

CI is green here while many broken links were found on #6394

So it doesn't work @jean-michelet?

jean-michelet · 2025-11-23T11:29:31Z

I guess, but I don't really know the workflow so maybe @Fdawgs can tell us more about this.

umxr · 2025-11-23T22:59:49Z

I dont think the link checker workflow ran because it only triggers on markdown file changes:

paths: "**/*.md"

This PR initially only modified .github/workflows/links-check.yml, so the workflow never executed.

to test, I've added a trivial change to README.md to trigger the workflow and verify the external link checker works correctly.

jean-michelet · 2025-11-24T07:39:32Z

We should probably fix the links here.

jean-michelet · 2025-11-24T07:43:38Z

.github/workflows/links-check.yml


 on:
  pull_request:
    paths:


Shouldn't we detect when the workflow file itself is updated?

".github/workflows/links-check.yml"

umxr · 2025-11-24T20:08:08Z

These links are flagged as "fragment not found" but are actually valid. They either use hash-based routing (SPAs) or the fragments do exist:

  - https://sinclairzx81.github.io/typebox/#/docs/overview/2_setup
  - https://getpino.io/#/
  - https://getpino.io/#/docs/api?id=opt-serializers
  - https://getpino.io/#/docs/redaction
  - https://github.com/fastify/fastify/issues/946#issuecomment-766319521
  - https://github.com/openjs-foundation/cross-project-council/blob/HEAD/PROJECT_PROGRESSION.md#at-large-projects
  - https://github.com/fastify/fastify/blob/94ea67ef2d8dce8a955d510cd9081aabd036fa85/test/hooks-async.js#L269-L275
  - https://github.com/galiprandi/fastify-lm#readme
  - https://github.com/fastify/fastify/issues/1426#issuecomment-817957913
  - https://github.com/pinojs/pino/blob/main/docs/api.md#level-string
  - https://github.com/pinojs/pino/blob/main/docs/api.md#serializers-object
  - https://github.com/pinojs/pino/blob/main/docs/api.md#options

I still expect the link checks to fail on some of these due to the action detecting a fragment in the URL, even though the links are correct. I'll review the CI again and look into adding these to linksToSkip or create a regex if needed.

Question re - https://www.letzdoitapp.com/ -> This domain appears to no longer exist. What should we do here - remove the link entirely, or keep the name but remove the hyperlink?

jean-michelet · 2025-11-25T06:49:53Z

I suspect linkinator reports fragment links as broken when the corresponding id isn’t present in the HTML.
This is expected with HashRouter, but GitHub also generates its own slug-based anchors, which is surprisingly not detected by the tool.

Eomm · 2026-01-17T14:14:42Z

we have this PR too: #6424

Not yet checked this PR to evaluate the differences tho

gurgunday

linkinator is a good lib, the maintainer is active too, I think we can proceed with this, but CI needs to be fixed

.github/workflows/links-check.yml

Eomm · 2026-01-25T10:41:48Z

CONTRIBUTING.md

   file. This list is also sorted alphabetically so make sure to add your name
   in the proper order. Use your GitHub profile icon for the `picture:` field.
-5. Read the [pinned announcements](https://github.com/orgs/fastify/discussions/categories/announcements)
+5. Read the [pinned announcements](https://github.com/fastify/fastify/discussions/categories/announcements)


this must not change, see the linksToSkip suggestion

updated here - 2359f2f

we have the following in link-checks.yml so i dont think we need to add the complete url to this property

linksToSkip: "https://github.com/orgs/fastify/.*"

Eomm · 2026-01-25T10:41:53Z

EXPENSE_POLICY.md

 - Hosting

-**Before making any purchases**, initiate a [new discussion](https://github.com/orgs/fastify/discussions)
+**Before making any purchases**, initiate a [new discussion](https://github.com/fastify/fastify/discussions)


this must not change, see the linksToSkip suggestion

updated here - 2359f2f

we have the following in link-checks.yml so i dont think we need to add the complete url to this property

linksToSkip: "https://github.com/orgs/fastify/.*"

Eomm · 2026-01-25T10:42:18Z

README.md

 - [Platformatic](https://platformatic.dev)

 Past Sponsors:
 - [LetzDoIt](https://www.letzdoitapp.com/)


This link is dead, why it has not been catched?

I think we need to update the paths

Updated here - 9750c33 the paths trigger from '.md' to '**/.md' so the workflow runs when any markdown file in the repository is modified (including those in subdirectories like test/bundler/README.md).

README.md

.github/workflows/links-check.yml

Eomm · 2026-01-25T10:55:22Z

linkinator is a good lib, the maintainer is active too, I think we can proceed with this, but CI needs to be fixed

I checked the various PR and I think this one is good to go with some suggestions 👍🏼
Thanks @umxr for opening it

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

gurgunday

lgtm

Eomm · 2026-02-01T11:14:02Z

.github/workflows/links-check.yml

      - name: Link Checker
        id: lychee
-        uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2.7.0
+        uses: lycheeverse/lychee-action@2.7


For security policy, we prefer the commit hash

Suggested change

uses: lycheeverse/lychee-action@2.7

uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2.7.0

my bad, addressed here - 2c67f0a

just bumped the version of JustinBeckwith/linkinator-action to v2.4.0 to see if they've fixed the fragment not found error

EXPENSE_POLICY.md

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

Eomm

We have few links to fix, but it is up to us:

Scanned total of 868 links!
Error: Detected 105 broken links.

umxr added 2 commits November 10, 2025 19:44

feat: add external link checker using linkinator-action

3af245c

Adds external link validation to spot dead links (status code != 200) while keeping existing internal link checker. Fixes fastify#6385

fix: correct regex escape in external link checker skip pattern

2184d31

github-actions bot added the github actions Github actions related label Nov 10, 2025

Fdawgs changed the title ~~feat: add external link checker using linkinator-action~~ ci(links-check): add external link checker using linkinator-action Nov 12, 2025

Uzlopak reviewed Nov 13, 2025

View reviewed changes

.github/workflows/links-check.yml Outdated Show resolved Hide resolved

Uzlopak reviewed Nov 13, 2025

View reviewed changes

.github/workflows/links-check.yml Outdated Show resolved Hide resolved

Uzlopak reviewed Nov 13, 2025

View reviewed changes

fix: correct path pattern for external link checker in workflow

d9bb77f

Fdawgs reviewed Nov 15, 2025

View reviewed changes

.github/workflows/links-check.yml Outdated Show resolved Hide resolved

drop "skip"

98df210

umxr requested a review from Fdawgs November 15, 2025 12:33

Merge branch 'main' into add-external-link-checker

b7a7fa3

mcollina approved these changes Nov 23, 2025

View reviewed changes

gurgunday reviewed Nov 23, 2025

View reviewed changes

umxr added 2 commits November 23, 2025 22:53

chore: trigger link checker workflow for testing

ff82b91

Merge branch 'main' into add-external-link-checker

416de19

jean-michelet reviewed Nov 24, 2025

View reviewed changes

umxr added 2 commits November 24, 2025 20:01

chore: include links-check.yml in paths for link checking

99dde1b

docs: update broken links

4656edd

github-actions bot added the documentation Improvements or additions to documentation label Nov 24, 2025

gurgunday reviewed Jan 18, 2026

View reviewed changes

Eomm reviewed Jan 25, 2026

View reviewed changes

This was referenced Jan 25, 2026

ci: Add. external link checker #6424

Closed

Fix broken documentation links and add link checker tool #6462

Closed

umxr and others added 6 commits January 25, 2026 16:48

Update .github/workflows/links-check.yml

1cc0945

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

Update README.md

0b65d80

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

Update .github/workflows/links-check.yml

50a55a5

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

fix: revert links

2359f2f

fix: update paths to trigger on all markdown files

9750c33

Merge branch 'main' into add-external-link-checker

6481e36

gurgunday approved these changes Jan 25, 2026

View reviewed changes

umxr added 2 commits February 1, 2026 00:02

fix: update link checker actions to latest versions

4a52d4b

Merge branch 'main' into add-external-link-checker

d2491d3

Eomm reviewed Feb 1, 2026

View reviewed changes

fix: use commit hash

2c67f0a

gurgunday approved these changes Feb 1, 2026

View reviewed changes

Eomm reviewed Feb 1, 2026

View reviewed changes

EXPENSE_POLICY.md Outdated Show resolved Hide resolved

umxr and others added 3 commits February 11, 2026 21:22

Update EXPENSE_POLICY.md

1915853

Co-authored-by: Manuel Spigolon <behemoth89@gmail.com> Signed-off-by: Umar Gora <umarg1997@gmail.com>

Merge branch 'main' into add-external-link-checker

68609b7

Merge branch 'main' into add-external-link-checker

e802c95

Eomm approved these changes Feb 15, 2026

View reviewed changes

Eomm merged commit 1bcba2c into fastify:main Feb 15, 2026
33 of 34 checks passed

Fdawgs mentioned this pull request Feb 17, 2026

fix: resolve broken links in documentation (#6385) #6498

Closed

8 tasks

	uses: lycheeverse/lychee-action@2.7
	uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2.7.0

Uh oh!

Conversation

umxr commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uh oh!

Uh oh!

Uzlopak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jean-michelet commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

gurgunday left a comment

Choose a reason for hiding this comment

Uh oh!

jean-michelet commented Nov 23, 2025

Uh oh!

umxr commented Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jean-michelet commented Nov 24, 2025

Uh oh!

jean-michelet Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

umxr commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jean-michelet commented Nov 25, 2025

Uh oh!

Eomm commented Jan 17, 2026

Uh oh!

gurgunday left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Eomm commented Jan 25, 2026

Uh oh!

gurgunday left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Eomm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

umxr commented Nov 10, 2025 •

edited

Loading

jean-michelet commented Nov 22, 2025 •

edited

Loading

umxr commented Nov 23, 2025 •

edited

Loading

jean-michelet Nov 24, 2025 •

edited

Loading

umxr commented Nov 24, 2025 •

edited

Loading