Skip to content

Commit 1be9fcf

Browse files
zeitlingertrask
andauthored
use common link checker and fix links (#7733)
Co-authored-by: Trask Stalnaker <[email protected]>
1 parent e658462 commit 1be9fcf

File tree

5 files changed

+58
-16
lines changed

5 files changed

+58
-16
lines changed

.github/config/lychee.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
timeout = 30
2+
retry_wait_time = 5
3+
max_retries = 6
4+
max_concurrency = 4
5+
6+
# Check link anchors
7+
include_fragments = true
8+
9+
remap = [
10+
# workaround for https://github.com/lycheeverse/lychee/issues/1729
11+
'https://github.com/(.*?)/(.*?)/blob/(.*?)/(.*#.*)$ https://raw.githubusercontent.com/$1/$2/$3/$4',
12+
]
13+
14+
# excluding links to pull requests and issues is done for performance
15+
exclude = [
16+
'^https://github.com/open-telemetry/opentelemetry-java/(issues|pull)/\d+$',
17+
'^https://www.javadoc.io/badge/(.*?)/(.*?).svg$', # returns 522
18+
]
Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Reusable - Markdown link check
1+
name: Reusable - Link check
22

33
on:
44
workflow_call:
@@ -7,19 +7,22 @@ permissions:
77
contents: read
88

99
jobs:
10-
markdown-link-check:
10+
link-check:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
14-
15-
- uses: lycheeverse/lychee-action@885c65f3dc543b57c898c8099f4e08c8afd178a2 # v2.6.1
1614
with:
17-
lycheeVersion: v0.18.1
18-
# excluding links to pull requests and issues is done for performance
19-
args: >
20-
--include-fragments
21-
--exclude "^https://github.com/open-telemetry/opentelemetry-java/(issues|pull)/\\d+$"
22-
--max-retries 6
23-
--retry-wait-time 10
24-
--max-concurrency 4
25-
.
15+
fetch-depth: 0 # needed for merge-base used in lint:links-in-modified-files
16+
17+
- uses: jdx/mise-action@e3d7b8d67a7958d1207f6ed871e83b1ea780e7b0 # v3.3.1
18+
19+
- name: Link check - relative links (all files)
20+
if: github.event_name == 'pull_request'
21+
env:
22+
GITHUB_TOKEN: ${{ github.token }}
23+
run: mise run lint:local-links
24+
25+
- name: Link check (modified files only)
26+
env:
27+
GITHUB_TOKEN: ${{ github.token }}
28+
run: mise run lint:links-in-modified-files --base origin/${{ github.base_ref }} --head ${{ github.event.pull_request.head.sha }} --event ${{ github.event_name }}

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1429,7 +1429,7 @@ the [Logs Bridge API](https://github.com/open-telemetry/opentelemetry-specificat
14291429
is _not_ meant for end users. Log appenders use the API to bridge logs from existing log
14301430
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
14311431
dictate how logs are processed and exported.
1432-
See [opentelemetry.io](https://opentelemetry.io/docs/instrumentation/java/manual/#logs) for
1432+
See [opentelemetry.io](https://opentelemetry.io/docs/languages/java/api/#loggerprovider) for
14331433
documentation on usage.
14341434

14351435
### API
@@ -3902,7 +3902,7 @@ See the `opentelemetry-extension-kotlin` module for details.
39023902

39033903
#### Breaking changes
39043904

3905-
- There have been many updates to the semantic conventions constants. The constants are now auto-generated from the YAML specification files, so the names will now be consistent across languages. For more information, see the [YAML Model for Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/model#yaml-model-for-semantic-conventions).
3905+
- There have been many updates to the semantic conventions constants. The constants are now auto-generated from the YAML specification files, so the names will now be consistent across languages. For more information, see the [YAML Model for Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/model/README.md#yaml-model-for-semantic-conventions).
39063906
- All API classes have been moved into the `io.opentelemetry.api.` prefix to support JPMS users.
39073907
- The API no longer uses the `grpc-context` as the context implementation. It now uses `io.opentelemetry.context.Context`. This is published in the `opentelemetry-context` artifact. Interactions with the context were mostly moved to static methods in the `Span` and `Baggage` interfaces.
39083908
- The Baggage API has been reworked to more closely match the specification. This includes the removal of the `BaggageManager`. Baggage is fully functional within the API, without needing to install an SDK.

mise.toml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[tools]
2+
lychee = "0.20.1"
3+
4+
[settings]
5+
# Only install tools explicitly defined in the [tools] section above
6+
idiomatic_version_file_enable_tools = []
7+
8+
# Windows configuration for file-based tasks
9+
# Based on: https://github.com/jdx/mise/discussions/4461
10+
windows_executable_extensions = ["sh"]
11+
windows_default_file_shell_args = "bash"
12+
use_file_shell_for_executable_tasks = true
13+
14+
[tasks."lint:links"]
15+
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/links.sh"
16+
17+
[tasks."lint:local-links"]
18+
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/local-links.sh"
19+
20+
[tasks."lint:links-in-modified-files"]
21+
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/links-in-modified-files.sh"

sdk-extensions/incubator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,4 @@ Additional notes on usage:
122122
[`last_value`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#last-value-aggregation
123123
[`drop`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation
124124
[`explicit_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation
125-
[`exponential_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exponential-bucket-histogram-aggregation
125+
[`exponential_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#base2-exponential-bucket-histogram-aggregation

0 commit comments

Comments
 (0)