chore: checks links in typedoc html #2669
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #2669 +/- ##
=======================================
Coverage 92.53% 92.53%
=======================================
Files 144 144
Lines 5186 5186
Branches 1106 1106
=======================================
Hits 4799 4799
Misses 387 387 |
legendecas
commented
Dec 16, 2021
| @@ -174,7 +172,7 @@ For a more detailed breakdown of feature support see the [specification complian | |||
| We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and | |||
| [good first issue][good-first-issues] to get started with the project. For | |||
| instructions to build and make changes to this project, see the | |||
| [CONTRIBUTING](CONTRIBUTING.md) guide. | |||
| [CONTRIBUTING][CONTRIBUTING] guide. | |||
There was a problem hiding this comment.
Markdown link is not accessible in typedoc generated sites.
| @@ -33,8 +33,6 @@ | |||
| • | |||
| <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/development-guide.md">Development Guide</a> | |||
| • | |||
| <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/benchmark/README.md">Benchmarks</a> | |||
There was a problem hiding this comment.
Benchmarks have been removed in #2462.
legendecas
force-pushed
the
link-checker
branch
4 times, most recently
from
02557fc
to
0a468f3
Compare
legendecas
force-pushed
the
link-checker
branch
from
0a468f3
to
f52d89a
Compare
|
No idea why the |
legendecas
force-pushed
the
link-checker
branch
from
f32f6c1
to
0e70083
Compare
|
This PR is ready for review. There are chances that typedoc will fail on the CI for OOM, though I didn't constantly reproduce the problem locally. So increasing the memory limit for now. |
dyladan
reviewed
Dec 28, 2021
dyladan
approved these changes
Dec 28, 2021
vmarchaud
approved these changes
Dec 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which problem is this PR solving?
#2657 only checks on markdown files (and doesn't interpret HTML in markdown files). Adopt the tool linkinator that already used in opentelemetry-js-api.
Type of change
Checklist: