Skip to content

Use flint for link checking #2654

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.

Sign up for GitHub

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

Merged
jaydeluca merged 6 commits into from
Mar 22, 2026
Merged

Use flint for link checking #2654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13dd241
Use flint for link checking
zeitlinger Feb 25, 2026
754b586
Remove accidentally committed files
zeitlinger Feb 25, 2026
a0395c2
Update flint to v0.8.0
zeitlinger Mar 11, 2026
c309e07
fix: use /tree/ instead of /blob/ for directory URLs
zeitlinger Mar 12, 2026
920369b
chore: exclude flaky groovy-lang.org from link checks
zeitlinger Mar 12, 2026
ea9d6a6
Update flint to v0.9.1
zeitlinger Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions .github/config/lychee.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,9 @@ max_concurrency = 4
# Check link anchors
include_fragments = true

remap = [
# workaround for https://github.com/lycheeverse/lychee/issues/1729
"https://github.com/(.*?)/(.*?)/blob/(.*?)/(.*#.*)$ https://raw.githubusercontent.com/$1/$2/$3/$4"
]

exclude = [
# excluding links to pull requests and issues is done for performance
"^https://github.com/open-telemetry/opentelemetry-java-contrib/(issues|pull)/\\d+$",
# groovy-lang.org is frequently unreachable / times out
"^https?://[^/]*groovy-lang\\.org",
]
11 changes: 11 additions & 0 deletions .github/renovate.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,17 @@
},
],
customManagers: [
{
// keep SHA-pinned raw.githubusercontent.com URLs in mise.toml up to date
customType: 'regex',
datasourceTemplate: 'github-tags',
managerFilePatterns: [
'/^mise\\.toml$/',
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this repo’s Renovate config, customManagers[].managerFilePatterns is consistently using glob patterns (e.g., .github/workflows/**, **/*.java). The newly added '/^mise\\.toml$/' includes regex delimiters and likely won’t match mise.toml, which would prevent Renovate from updating the flint SHA pin. Use a consistent file pattern that matches mise.toml (e.g., mise.toml or a glob/regex string consistent with the other entries).

Suggested change
'/^mise\\.toml$/',
'mise.toml',

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member

@jaydeluca jaydeluca Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this pattern seems to be working fine in the instrumentation repo (example)

],
matchStrings: [
'https://raw\\.githubusercontent\\.com/(?<depName>[^/]+/[^/]+)/(?<currentDigest>[a-f0-9]{40})/.*#\\s*(?<currentValue>v\\S+)',
],
},
{
customType: 'regex',
datasourceTemplate: 'npm',
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/reusable-link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ jobs:
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0 # needed for merge-base used in lint:links-in-modified-files
fetch-depth: 0 # needed for merge-base used in modified-files mode

- uses: jdx/mise-action@6d1e696aa24c1aa1bcc1adea0212707c71ab78a8 # v3.6.1

- name: Link check for pull requests
if: github.event_name == 'pull_request'
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
mise run lint:local-links
mise run lint:links-in-modified-files --base origin/${{ github.base_ref }} --head ${{ github.event.pull_request.head.sha }}
GITHUB_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
PR_HEAD_REPO: ${{ github.event.pull_request.head.repo.full_name }}
run: mise run lint:links

- name: Link check for pushes and scheduled workflows
if: github.event_name != 'pull_request'
env:
GITHUB_TOKEN: ${{ github.token }}
run: mise run lint:links
run: mise run lint:links --full
36 changes: 0 additions & 36 deletions .mise/tasks/lint/links-in-modified-files.sh
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions .mise/tasks/lint/links.sh
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions .mise/tasks/lint/local-links.sh
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion cel-sampler/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To use:
* Follow the [instructions](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/incubator/README.md#declarative-configuration) to configure OpenTelemetry with declarative configuration.
* Configure the `.tracer_provider.sampler` to include the `cel_based` sampler.

Support is now available for the java agent, see an [example here](https://github.com/open-telemetry/opentelemetry-java-examples/blob/main/javaagent).
Support is now available for the java agent, see an [example here](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/javaagent).

## Overview

Expand Down
2 changes: 1 addition & 1 deletion jmx-scraper/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Like with the JMX Gatherer, the selection of provided metrics to use is still do
However, there is now two distinct sets of metrics to select from using the `otel.jmx.target.source` configuration option:

- `legacy`: [metrics definitions](./src/main/resources) equivalent to JMX Gatherer definitions to help transition and preserve compatibility
- `instrumentation`: [metrics definitions inherited from instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/), which is now used as a reference for JMX metrics, those also aim to provide better alignment with [metrics semantic conventions](https://opentelemetry.io/docs/specs/semconv/general/metrics/).
- `instrumentation`: [metrics definitions inherited from instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/), which is now used as a reference for JMX metrics, those also aim to provide better alignment with [metrics semantic conventions](https://opentelemetry.io/docs/specs/semconv/general/metrics/).

In both cases, the metrics definitions themselves are embedded in the JMX Scraper binary, thus they
will only change if the release version of the JMX Scraper binary changes.
Expand Down
5 changes: 5 additions & 0 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,8 @@ idiomatic_version_file_enable_tools = []
windows_executable_extensions = ["sh"]
windows_default_file_shell_args = "bash"
use_file_shell_for_executable_tasks = true

# Pick the tasks you need from flint (https://github.com/grafana/flint)
[tasks."lint:links"]
description = "Check for broken links in changed files + all local links"
file = "https://raw.githubusercontent.com/grafana/flint/8a39d96e17327c54974623b252eb5260d67ed68a/tasks/lint/links.sh" # v0.9.1
2 changes: 1 addition & 1 deletion samplers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To use:
* Follow the [instructions](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/incubator/README.md#declarative-configuration) to configure OpenTelemetry with declarative configuration.
* Configure the `.tracer_provider.sampler` to include the `rule_based_routing` sampler.

Support is now available for the java agent, see an [example here](https://github.com/open-telemetry/opentelemetry-java-examples/blob/main/javaagent).
Support is now available for the java agent, see an [example here](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/javaagent).

Schema for `rule_based_routing` sampler:

Expand Down
Loading