Make it easier to run lychee locally

[Copilot]

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

Changes

• Added lychee.toml - Configuration file with appropriate settings for the contrib repo (excludes PR/issue links, sets retry and concurrency limits)
• Added .github/scripts/check-links.sh - Shell script that allows developers to run lychee locally using Docker with the same configuration as CI
• Added .github/scripts/dependencies.dockerfile - Dockerfile to help Renovate auto-update lychee versions
• Replaced workflow - Replaced reusable-markdown-link-check.yml with reusable-check-links.yml that uses the new script
• Updated build pipeline - Modified build.yml to reference the new workflow

Usage

Developers can now easily check links locally before pushing:

# Run with GitHub token (recommended for higher rate limits)
GITHUB_TOKEN=your_token ./.github/scripts/check-links.sh

# Or run without token
./.github/scripts/check-links.sh

The script automatically:

• Uses the same Docker image and configuration as CI
• Handles TTY allocation appropriately
• Passes through GitHub token if available
• Provides verbose output for debugging

This improves the development workflow by allowing developers to catch link issues early without waiting for CI.

Fixes #5.

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:

• api.scorecard.dev
  • Triggering command: /usr/local/bin/lychee --verbose --config ./lychee.toml . (dns block)
• app.fossa.com
  • 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.oracle.com
  • Triggering command: /usr/local/bin/lychee --verbose --config ./lychee.toml . (dns block)
• en.wikipedia.org
  • Triggering command: /usr/local/bin/lychee --verbose --config ./lychee.toml . (dns block)
• img.shields.io
  • Triggering command: /usr/local/bin/lychee --verbose --config ./lychee.toml . (dns block)
• 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)
• 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:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to my firewall allow list

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.