chore: change link checker config to internal links only

Redocly / redocly-cli

⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.

https://redocly.com/docs/cli/

MIT License

944 stars 149 forks source link

chore: change link checker config to internal links only #1612

Closed lornajane closed 4 months ago

lornajane commented 4 months ago

What/Why/How?

We have a link checker, but if a 3rd party site is down then we see a build failure when in fact it's not a fault on our side. This pull request adjusts the link checking to be local-only in the CI pipeline that is used on every pull request.

This change brings the checks in line with the other docs sites.

Check yourself

[ ] Code changed? - Tested with redoc/reference-docs/workflows (internal)
[x] All new/updated code is covered with tests
[ ] New package installed? - Tested in different environments (browser/node)

Security

[x] Security impact of change has been considered
[x] Code follows company security practices and guidelines

changeset-bot[bot] commented 4 months ago

⚠️ No Changeset found

Latest commit: 11d4e9117b716ed066bb40a00ad0a40127b047bf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions[bot] commented 4 months ago

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	987.3 ± 24.2	955.0	1039.4	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	992.4 ± 24.4	962.6	1046.7	1.01 ± 0.03

github-actions[bot] commented 4 months ago

Coverage report

St.^{:grey_question:}	Category	Percentage	Covered / Total
🟡	Statements	77.26%	4506/5832
🟡	Branches	67.78%	2495/3681
🟡	Functions	70.98%	751/1058
🟡	Lines	77.47%	4242/5476

Test suite run success

750 tests passing in 105 suites.

Report generated by 🧪jest coverage report action from 11d4e9117b716ed066bb40a00ad0a40127b047bf

lornajane commented 4 months ago

What I'd like to do is add a separate CI task that runs the check every week and opens an issue if any link, including external links, is broken. The majority of external link check failures are other people's problems, not ours, and having that block every pull request isn't helping.