Skip to content

Use flint for link checking #8116

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

Open
zeitlinger wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −17
Open

Use flint for link checking #8116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 0 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,11 +9,6 @@ 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",
]

# excluding links to pull requests and issues is done for performance
exclude = [
"^https://github.com/open-telemetry/opentelemetry-java/(issues|pull)/\\d+$",
Expand Down
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 @@ -110,6 +110,17 @@
}
],
customManagers: [
{
// keep SHA-pinned raw.githubusercontent.com URLs in mise.toml up to date
customType: 'regex',
datasourceTemplate: 'github-tags',
managerFilePatterns: [
'/^mise\\.toml$/',
],
matchStrings: [
'https://raw\\.githubusercontent\\.com/(?<depName>[^/]+/[^/]+)/(?<currentDigest>[a-f0-9]{40})/.*#\\s*(?<currentValue>v\\S+)',
],
},
{
customType: 'regex',
datasourceTemplate: 'java-version',
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
10 changes: 3 additions & 7 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,7 @@ 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"]
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/links.sh"

[tasks."lint:local-links"]
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/local-links.sh"

[tasks."lint:links-in-modified-files"]
file = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-java-contrib/refs/heads/main/.mise/tasks/lint/links-in-modified-files.sh"
description = "Check for broken links in changed files + all local links"
file = "https://raw.githubusercontent.com/grafana/flint/8822bdc543f28f2c7dd1f697af4df6d89768c507/tasks/lint/links.sh" # v0.7.0
Loading