Skip to content

feat: Add markdown link checker for PRs #572

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat: Add markdown link checker for PRs #572

wants to merge 2 commits into from

Conversation

pthmas
Copy link
Contributor

@pthmas pthmas commented Jun 18, 2025

Overview

Adds a new GitHub action to check all the markdown hyperlinks for dead links.

@pthmas pthmas self-assigned this Jun 18, 2025
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

github-advanced-security[bot]
github-advanced-security bot found potential problems Jun 18, 2025
View reviewed changes
.github/workflows/markdowd_link_checker.yml
Comment on lines +15 to +18
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1

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 15 days ago

To fix the issue, we need to add a permissions block to the workflow. Since the workflow only checks Markdown links, it requires minimal permissions. The contents: read permission is sufficient for this task, as it allows the workflow to read repository contents without granting unnecessary write access.

The permissions block should be added at the root level of the workflow file to apply to all jobs. This ensures that the GITHUB_TOKEN used by the workflow has restricted access.

Suggested changeset 1
.github/workflows/markdowd_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/markdowd_link_checker.yml b/.github/workflows/markdowd_link_checker.yml
--- a/.github/workflows/markdowd_link_checker.yml
+++ b/.github/workflows/markdowd_link_checker.yml
@@ -2,2 +2,5 @@
 
+permissions:
+  contents: read
+
 on: 
EOF
@@ -2,2 +2,5 @@

permissions:
contents: read

on:
Copilot is powered by AI and may make mistakes. Always verify output.
.github/workflows/markdowd_link_checker.yml
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: tcort/github-action-markdown-link-check@v1

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Check Markdown links' step
Uses Step
Loading
uses 'tcort/github-action-markdown-link-check' with ref 'v1', not a pinned commit hash
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 18, 2025 •
edited
Loading

PR Preview Action v1.6.1

🚀 View preview at
https://rollkit.github.io/docs-preview/pr-572/

Built to branch main at 2025-06-27 14:23 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@pthmas pthmas

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pthmas