Change link checking from markdown-link-check to lychee (#1570)

This commit is contained in:
Trask Stalnaker 2024-12-20 12:37:28 -08:00 committed by GitHub
parent 889cb35050
commit 7febaa8168
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 10 additions and 52 deletions

View File

@ -1,15 +0,0 @@
{
"retryOn429": true,
"aliveStatusCodes": [
200,
403
],
"ignorePatterns": [
{
"pattern": "^https://developer\\.mend\\.io/github/open-telemetry/opentelemetry-java-contrib$"
},
{
"pattern": "^https://github.com/open-telemetry/opentelemetry-java-contrib/pulls/app%2Frenovate"
}
]
}

View File

@ -1,17 +0,0 @@
#!/bin/bash -e
# this script helps to reduce sporadic link check failures by retrying at a file-by-file level
retry_count=3
for file in "$@"; do
for i in $(seq 1 $retry_count); do
if markdown-link-check --config "$(dirname "$0")/../config/markdown-link-check-config.json" \
"$file"; then
break
elif [[ $i -eq $retry_count ]]; then
exit 1
fi
sleep 5
done
done

View File

@ -9,13 +9,13 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Install markdown-link-check
# TODO(jack-berg): use latest when config file reading bug is fixed: https://github.com/tcort/markdown-link-check/issues/246
run: npm install -g markdown-link-check@3.10.3
- name: Run markdown-link-check
run: |
find . -type f \
-name '*.md' \
-not -path './CHANGELOG.md' \
| xargs .github/scripts/markdown-link-check-with-retry.sh
- uses: lycheeverse/lychee-action@v2
with:
# remove version after next release of lychee-action
lycheeVersion: latest
# excluding links to pull requests and issues is done for performance
args: >
--include-fragments
--exclude "^https://github.com/open-telemetry/opentelemetry-java-contrib/(issue|pull)/\\d+$"
--max-retries 6
.

View File

@ -1,7 +1,5 @@
# OpenTelemetry Java Flight Recorder (JFR) Events
[![Javadocs][javadoc-image]][javadoc-url]
Create JFR events that can be recorded and viewed in Java Mission Control (JMC).
* Creates Open Telemetry Tracing/Span events for spans
@ -20,9 +18,6 @@ Create JFR events that can be recorded and viewed in Java Mission Control (JMC).
* Supports the Open Source version of JFR in Java 11.
* Might support back port to OpenJDK 8, but not tested and classes are built with JDK 11 bytecode.
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jfr-events.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jfr-events
## Component owners
- [Staffan Friberg](https://github.com/sfriberg)

View File

@ -1,7 +1,5 @@
# OpenTelemetry Noop API
[![Javadocs][javadoc-image]][javadoc-url]
An implementation of `OpenTelemetry` that is completely no-op. Unlike `OpenTelemetry#noop()`, this
implementation does not support in-process context propagation at all. This means that no objects
are allocated nor {@link ThreadLocal}s used in an application using this implementation.
@ -11,6 +9,3 @@ are allocated nor {@link ThreadLocal}s used in an application using this impleme
- [Jack Berg](https://github.com/jack-berg), New Relic
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-extension-noop-api.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-extension-noop-api