You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Broken links in the README, contributing guide, and source comments are now caught on every PR and push to main instead of being found by readers.
Things to note
README links to this repo's own files are now relative (./LICENSE etc.), so the check validates them against the PR's files instead of main. npm still renders them as GitHub links via the package repository field.
The checker only reads the listed files, so the generated CHANGELOG.md files are left out (the tool has no exclude syntax).
linkcheck.baseline.json ignores one false positive: the placeholder endpoint https://test/integration in a unit test.
The action is pinned to a commit SHA, like the other third-party actions in this repo's workflows.
Verification
Ran the pinned checker locally on the same globs: before the fix it reported 2 links to fix, after the fix and baseline it reports "No links to fix" (51 checked, 1 ignored by baseline). The new CI job has not been checked on GitHub yet.
Change outline
New workflow, runs on pull_request and push to main, with read-only contents permission:
{ "href": "https://test/integration",
"page": "projects/fingerprintjs-pro-angular/src/lib/fingerprint-angular.service.spec.ts",
"reason": "Placeholder endpoint in a unit test, not a real URL" }
Relative links are checked against the PR's own files, so a move or
delete that breaks one fails the PR. npm and pub.dev still render them
as GitHub links via the package's repository field.
Refs: INTER-2911
The source-file glob misses the existing source-comment link in bin/generate-version.js:4, so that URL can break without failing this job. Include the build/test scripts under bin as well, so source comments outside projects are checked as described.
Published README links to a file missing from the package
README.md:34
bin/copy_assets.sh copies this README into the published package, but the package does not contain projects/demo-angular21/src. The link therefore breaks when the bundled README is opened locally (for example, in an editor); npm's website rewrite does not help there. Please keep the checkout-relative link for CI but rewrite it to a GitHub URL in the published README, or include the target in the package.
Re the README demo link in the published package: declining. The link works where people read this README, on GitHub and on npmjs.com (npm rewrites relative links to the repository URL). Opening the copy inside node_modules in an editor is the one place it breaks, and rewriting links in copy_assets.sh would add a build step for that case. ./LICENSE is copied into the package, so it works everywhere.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
INTER-2911 | docs-link-checker
Why
Broken links in the README, contributing guide, and source comments are now caught on every PR and push to
maininstead of being found by readers.Things to note
./LICENSEetc.), so the check validates them against the PR's files instead ofmain. npm still renders them as GitHub links via the packagerepositoryfield.CHANGELOG.mdfiles are left out (the tool has no exclude syntax).linkcheck.baseline.jsonignores one false positive: the placeholder endpointhttps://test/integrationin a unit test.Verification
Ran the pinned checker locally on the same globs: before the fix it reported 2 links to fix, after the fix and baseline it reports "No links to fix" (51 checked, 1 ignored by baseline). The new CI job has not been checked on GitHub yet.
Change outline
New workflow, runs on
pull_requestandpushtomain, with read-onlycontentspermission:Link fix found by the first run (GitHub repo's default branch is
main):Baseline entry:
{ "href": "https://test/integration", "page": "projects/fingerprintjs-pro-angular/src/lib/fingerprint-angular.service.spec.ts", "reason": "Placeholder endpoint in a unit test, not a real URL" }