Make it easier to run lychee locally #12
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: trask <[email protected]>
Copilot
AI
changed the title
[WIP] Make it easier to run lychee locally
Make it easier to run lychee locally
Jun 29, 2025
Copilot stopped work on behalf of
trask due to an error
June 29, 2025 23:28
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR applies the changes from opentelemetry-java-instrumentation#14155 to enable local execution of lychee link checking with Docker.
Changes Made
New Files
lychee.toml- Configuration file with settings moved from workflow args, including the performance comment from the original workflow.github/scripts/check-links.sh- Docker-based script for local lychee execution.github/scripts/dependencies.dockerfile- Enables Renovate auto-updates for lychee Docker image.github/workflows/reusable-check-links.yml- New workflow that uses the script instead of lychee-actionModified Files
.github/workflows/build.yml- Updated to reference the newreusable-check-links.ymlworkflowRemoved Files
.github/workflows/reusable-markdown-link-check.yml- Replaced by the new script-based approachBenefits
✅ Local execution: Users can now run
GITHUB_TOKEN=xxx ./.github/scripts/check-links.shlocally✅ Same configuration: Uses identical settings as CI via shared
lychee.toml✅ Auto-updates: Renovate will keep the lychee Docker image version current
✅ Cross-platform: Works on Windows, macOS, and Linux with Docker
Configuration Moved
The following arguments were moved from the workflow to
lychee.toml:--include-fragments→include_fragments = true--exclude "^https://github.com/open-telemetry/opentelemetry-java-contrib/(issues|pull)/\\d+$"→excludearray--max-retries 6→max_retries = 6--max-concurrency 1→max_concurrency = 1The performance-related comment was preserved in the config file as requested.
Fixes #11.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.