-
Notifications
You must be signed in to change notification settings - Fork 169
update lychee and fix gh links with remap #2304
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update lychee and fix gh links with remap #2304
Conversation
.github/config/lychee.toml
Outdated
|
|
||
| exclude = [ | ||
| # Disabled until https://github.com/lycheeverse/lychee/issues/1729 is fixed | ||
| "^https://github.com/.*#.*$", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not ideal as it completely disables checking github links. Have you considered using the remap option. Perhaps that could be used to strip the anchor from github links?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
copilot suggested to add a remap that actually (with a little bit of tweaking) checking all anchors instead of discarding them.
Here's a link that is now verified as correct:
Several are not correct - not not fixed in this PR (yet)
[./CHANGELOG.md]:
[ERROR] https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/jmx-metrics#jmx-metric-insight | Cannot find fragment
[./consistent-sampling/README.md]:
[ERROR] https://raw.githubusercontent.com/open-telemetry/opentelemetry-specification/main/specification/trace/tracestate-probability-sampling.md#always-off-sampler | Cannot find fragment
[ERROR] https://raw.githubusercontent.com/open-telemetry/opentelemetry-specification/main/specification/trace/tracestate-probability-sampling.md#always-on-consistent-probability-sampler | Cannot find fragment
[ERROR] https://raw.githubusercontent.com/open-telemetry/opentelemetry-specification/main/specification/trace/tracestate-probability-sampling.md#consistentprobabilitybased-sampler | Cannot find fragment
[ERROR] https://raw.githubusercontent.com/open-telemetry/opentelemetry-specification/main/specification/trace/tracestate-probability-sampling.md#parentconsistentprobabilitybased-sampler | Cannot find fragment
[ERROR] https://raw.githubusercontent.com/open-telemetry/opentelemetry-specification/main/specification/trace/tracestate-probability-sampling.md#requirement-combine-multiple-consistent-probability-samplers-using-the-minimum-p-value | Cannot find fragment
[./jmx-scraper/README.md]:
[400] https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-instrumentation/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/ | Rejected status code (this depends on your "accept" configuration): Bad Request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wow, love that! 😍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wow, love that! 😍
all credits go to @laurit and copilot - they are an incredible combo 😜
| The future of the [JMX metrics](./jmx-metrics/README.md) component, | ||
| built on top of the | ||
| [JMX metrics](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/jmx-metrics#jmx-metric-insight) | ||
| [JMX metrics](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/README.md#jmx-metric-insight) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the original link is a bit better in this case (and isn't broken), how messy would the regex get if we wanted to accommodate it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually, maybe it's not better, linking directly to the README.md is nice too, let's leave it as is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the original link can't be checked by lychee
No description provided.