Add automated broken link checker workflow

[Copilot]

Configures automated link validation for markdown files using scheduled workflow and PR checks.

Implementation

• Action: Uses lycheeverse/lychee-action@v2.7.0 (SHA-pinned). The originally requested technote-space/broken-link-checker-action was archived in Nov 2022.
• Issue creation: Uses peter-evans/create-issue-from-file@v6.0.0 (SHA-pinned)
• Triggers: Monthly cron (0 0 1 * *), manual dispatch, PRs to main/develop
• Scope: All markdown files ('./**/*.md')
• Reliability: 3 retries, 30s timeout for flaky external links
• Issue creation: On schedule/manual runs only (suppressed for PRs via github.event_name != 'pull_request')

Configuration

permissions:
  contents: read
  issues: write

- uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0  # v2.7.0
  with:
    args: >-
      --verbose --no-progress
      --max-retries 3 --timeout 30
      './**/*.md'
    output: ./lychee/out.md
    fail: true

- uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710  # v6.0.0

Issues are automatically created with labels bug and documentation when broken links are detected.

Original prompt

Configuration Github Action: https://github.com/marketplace/actions/broken-link-checker-action

---

💡 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.

[Copilot]

Pull request overview

Adds a GitHub Actions workflow to automatically check for broken links and open labeled issues when failures are found.

Changes:

• Introduces a new Broken Link Check workflow with a monthly cron schedule.
• Enables manual triggering via workflow_dispatch.
• Configures technote-space/broken-link-checker-action with recursive crawling and issue metadata (labels/title).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

For supply-chain hardening, consider pinning the third-party action to a commit SHA instead of a floating major tag (@v2). Using only a major tag allows upstream changes to affect your workflow without review.

[Copilot]

PR description/checklist says the target should be the repository’s GitHub Pages, but the workflow currently targets the GitHub repo web UI (https://github.com/${{ github.repository }}). Update TARGET to the published Pages URL (typically https://${{ github.repository_owner }}.github.io//) so the check runs against the intended site.

[Copilot]

The workflow configures issue creation via the action (LABELS/TITLE), but the job doesn’t declare token permissions. To make issue creation reliably work across repo/org settings, add an explicit permissions: block (at least issues: write, and contents: read if needed) rather than relying on the repository default GITHUB_TOKEN permissions.

[Copilot]

repository_dispatch isn’t mentioned in the PR description/checklist (only schedule + manual trigger). If it’s not required, consider removing it to reduce the number of ways this workflow can be triggered; otherwise, document the intended external trigger use-case.

[Copilot]

This workflow starts with a YAML document marker (---) and quotes the on key ("on"). Other workflows in this repo use on: unquoted and omit --- (e.g., .github/workflows/validate-rules.yml:1-4). Consider aligning formatting for consistency.

[tuanductran]

@copilot use lycheeverse/lychee-action@v2.7.0 and peter-evans/create-issue-from-file@v6.0.0

[Copilot]

@copilot use lycheeverse/lychee-action@v2.7.0 and peter-evans/create-issue-from-file@v6.0.0

Updated to lychee-action v2.7.0 and create-issue-from-file v6.0.0 (both SHA-pinned) in commit 5f73c36.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• https://api.github.com/repos/lycheeverse/lychee-action/git/refs/tags/v2.7.0
  • Triggering command: /usr/bin/curl curl -s REDACTED (http 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 the custom allowlist in this repository's Copilot coding agent settings (admins only)