Skip to content

Add linkspector configuration for markdown file validation#961

Merged
egorikftp merged 1 commit into
mainfrom
task/update-linkinspector-logic
Apr 27, 2026
Merged

Add linkspector configuration for markdown file validation#961
egorikftp merged 1 commit into
mainfrom
task/update-linkinspector-logic

Conversation

@egorikftp

Copy link
Copy Markdown
Member

📝 Changelog

If this PR introduces user-facing changes, please update the relevant Unreleased section in changelogs:

@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 60e60d36-7426-4cdf-91a9-0230e7025251

📥 Commits

Reviewing files that changed from the base of the PR and between 4b483fa and bea4c1f.

📒 Files selected for processing (2)
  • .github/.linkspector.yml
  • .github/workflows/validation.yml
✅ Files skipped from review due to trivial changes (1)
  • .github/.linkspector.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/validation.yml

Walkthrough

The Linkspector GitHub Action configuration was changed to read settings from .github/.linkspector.yml. A new .github/.linkspector.yml file was added that targets the repository root (./), restricts checks to Markdown (.md) files, and ignores URLs beginning with https://join.slack.com. The workflow step no longer includes the explicit fail_on_error: true input and instead supplies only the config_file input.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding linkspector configuration for markdown file validation, which matches the changeset.
Description check ✅ Passed The PR description includes the required changelog template with checklist items for all three components, matching the repository's description template structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch task/update-linkinspector-logic

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@egorikftp egorikftp force-pushed the task/update-linkinspector-logic branch from 503f697 to 4b483fa Compare April 27, 2026 09:07

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/.linkspector.toml (1)

1-8: ⚠️ Potential issue | 🔴 Critical

Linkspector config is invalid: wrong format and unsupported keys — exclusion will not take effect.

The file is written in TOML format, but linkspector only supports YAML configuration (.linkspector.yml). Additionally, the configuration uses unsupported keys: [settings] and exclude_urls do not exist in linkspector's schema. The recognized keys are files / dirs / excludedFiles / excludedDirs / baseUrl / ignorePatterns / replacementPatterns / aliveStatusCodes / useGitIgnore / modifiedFilesOnly / httpHeaders.

As a result:

  1. The workflow will either fail to parse the TOML as YAML or silently fall back to defaults.
  2. The https://join.slack.com exclusion will not work since exclude_urls is not supported.

Rename to .github/.linkspector.yml and use the documented schema:

dirs:
  - .
ignorePatterns:
  - pattern: '^https://join\.slack\.com'
useGitIgnore: true

Update .github/workflows/validation.yml:

-          config_file: .github/.linkspector.toml
+          config_file: .github/.linkspector.yml

(Note: dirs: [.] with useGitIgnore: true recursively picks up all tracked *.md files, matching the original intent.)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/.linkspector.toml around lines 1 - 8, The linkspector config is
currently written in TOML using unsupported keys ([settings], exclude_urls) so
exclusions won't work; replace the TOML config with a YAML linkspector config
(use .linkspector.yml) and remove unsupported keys, using the supported keys
instead—e.g. use dirs (or files), ignorePatterns with a regex for
'^https://join\.slack\.com', and useGitIgnore: true; ensure you delete the TOML
file and add the YAML file so the workflow parses the correct schema.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In @.github/.linkspector.toml:
- Around line 1-8: The linkspector config is currently written in TOML using
unsupported keys ([settings], exclude_urls) so exclusions won't work; replace
the TOML config with a YAML linkspector config (use .linkspector.yml) and remove
unsupported keys, using the supported keys instead—e.g. use dirs (or files),
ignorePatterns with a regex for '^https://join\.slack\.com', and useGitIgnore:
true; ensure you delete the TOML file and add the YAML file so the workflow
parses the correct schema.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 0ab727d3-8030-4be8-a153-824d56d210ff

📥 Commits

Reviewing files that changed from the base of the PR and between 817bbd3 and 503f697.

📒 Files selected for processing (2)
  • .github/.linkspector.toml
  • .github/workflows/validation.yml

@egorikftp egorikftp force-pushed the task/update-linkinspector-logic branch from 4b483fa to bea4c1f Compare April 27, 2026 09:09
@egorikftp

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@egorikftp egorikftp merged commit 86cd1cc into main Apr 27, 2026
3 checks passed
@egorikftp egorikftp deleted the task/update-linkinspector-logic branch April 27, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant