Skip to content

(experimental) broken link checker (lychee) #2792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

dev-dist
Copy link
Collaborator

@dev-dist dev-dist commented Jul 2, 2025

No description provided.

Copy link

vercel bot commented Jul 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Jul 2, 2025 4:23pm

Comment on lines 9 to 25
runs-on: ubuntu-latest
steps:
- name: "☁️ Checkout Repository"
# Pinned to a full commit SHA to satisfy security best practices
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

- name: "🔎 Run Link Checker"
# Pinned to a full commit SHA to satisfy the sha-ref validation error
uses: lycheeverse/lychee-action@2b591b68953f656281b36952a78484920668b598 # v2
with:
# Points to your source files and uses your lycheerc config
args: "--config ./lycheerc ./src/content/**/*.md*"
# Ensures the step passes so the check doesn't show as "failed"
fail: false
env:
# Required to check GitHub links without being rate-limited
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {contents: read}

Copilot Autofix

AI 4 days ago

To fix the issue, we will add a permissions block at the root of the workflow file. Since the workflow only needs to read repository contents and use the GITHUB_TOKEN for checking links, we will set contents: read as the minimal required permission. This ensures the workflow adheres to the principle of least privilege.


Suggested changeset 1
.github/workflows/link-checker.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml
--- a/.github/workflows/link-checker.yml
+++ b/.github/workflows/link-checker.yml
@@ -6,2 +6,5 @@
 
+permissions:
+  contents: read
+
 jobs:
EOF
@@ -6,2 +6,5 @@

permissions:
contents: read

jobs:
Copilot is powered by AI and may make mistakes. Always verify output.
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.

1 participant