Skip to content

Conversation

Copy link

Copilot AI commented Jun 30, 2025

This PR applies the changes from open-telemetry/opentelemetry-java-instrumentation#14155 to make it easier to run lychee link checking locally.

Changes made:

  • Added .github/scripts/dependencies.dockerfile - Contains the lychee Docker image version that Renovate can auto-update
  • Added .github/scripts/link-check.sh - A script that runs lychee locally using Docker, eliminating the need to install lychee directly on the local machine
  • Added .lychee.toml - Configuration file for lychee with appropriate excludes and settings
  • Added .github/workflows/reusable-link-check.yml - New workflow that uses the custom script instead of the lychee-action
  • Removed .github/workflows/reusable-markdown-link-check.yml - Old workflow that used lychee-action
  • Updated .github/workflows/build.yml - Changed references from markdown-link-check to link-check

Benefits:

  1. Easier local development - Developers can now run ./github/scripts/link-check.sh locally without installing lychee
  2. Consistent environment - Uses the same Docker image version locally and in CI
  3. Auto-updates - Renovate can automatically update the lychee version in the dependencies.dockerfile
  4. Better configuration - Uses a dedicated .lychee.toml config file instead of inline arguments

To run link checking locally, developers just need Docker and can execute:

./github/scripts/link-check.sh

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
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • api.scorecard.dev
  • app.fossa.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • cassandra.apache.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • central.sonatype.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • cloud-native.slack.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • cloud.google.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • contrib.rocks
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • developer.mend.io
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • docs.aws.amazon.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • docs.cloudfoundry.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • docs.groovy-lang.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • docs.jboss.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • docs.oracle.com
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • en.wikipedia.org
  • groovy-lang.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • hadoop.apache.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • hbase.apache.org
  • img.shields.io
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • kafka.apache.org
  • opentelemetry.io
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • plugins.jenkins.io
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • scorecard.dev
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • semver.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • solr.apache.org
    • Triggering command: /usr/local/bin/lychee --verbose --config .lychee.toml . (dns block)
  • www.eclipse.org
  • www.jaegertracing.io
    • Triggering command: /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.

Copilot AI changed the title [WIP] Make it easier to run lychee locally Make it easier to run lychee locally Jun 30, 2025
Copilot AI requested a review from trask June 30, 2025 00:54
Copilot finished work on behalf of trask June 30, 2025 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make it easier to run lychee locally

3 participants