Make it easier to run lychee locally #32
Closed
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 open-telemetry/opentelemetry-java-instrumentation#14155 to make it easier to run lychee link checking locally.
Changes made:
.github/scripts/dependencies.dockerfile- Contains the lychee Docker image version that Renovate can auto-update.github/scripts/link-check.sh- A script that runs lychee locally using Docker, eliminating the need to install lychee directly on the local machine.lychee.toml- Configuration file for lychee with appropriate excludes and settings.github/workflows/reusable-link-check.yml- New workflow that uses the custom script instead of the lychee-action.github/workflows/reusable-markdown-link-check.yml- Old workflow that used lychee-action.github/workflows/build.yml- Changed references frommarkdown-link-checktolink-checkBenefits:
./github/scripts/link-check.shlocally without installing lychee.lychee.tomlconfig file instead of inline argumentsTo run link checking locally, developers just need Docker and can execute:
Fixes #31.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
activemq.apache.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)api.scorecard.devapp.fossa.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)cassandra.apache.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)central.sonatype.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)cloud-native.slack.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)cloud.google.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)contrib.rocks/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)developer.mend.io/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)docs.aws.amazon.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)docs.cloudfoundry.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)docs.groovy-lang.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)docs.jboss.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)docs.oracle.com/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)en.wikipedia.orggroovy-lang.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)hadoop.apache.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)hbase.apache.orgimg.shields.io/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)kafka.apache.orgopentelemetry.io/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)plugins.jenkins.io/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)scorecard.dev/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)semver.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)solr.apache.org/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)www.eclipse.orgwww.jaegertracing.io/usr/local/bin/lychee --verbose --config .lychee.toml .(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.