Add linkspector configuration for markdown file validation#961
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThe Linkspector GitHub Action configuration was changed to read settings from 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
503f697 to
4b483fa
Compare
There was a problem hiding this comment.
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 | 🔴 CriticalLinkspector 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]andexclude_urlsdo not exist in linkspector's schema. The recognized keys arefiles/dirs/excludedFiles/excludedDirs/baseUrl/ignorePatterns/replacementPatterns/aliveStatusCodes/useGitIgnore/modifiedFilesOnly/httpHeaders.As a result:
- The workflow will either fail to parse the TOML as YAML or silently fall back to defaults.
- The
https://join.slack.comexclusion will not work sinceexclude_urlsis not supported.Rename to
.github/.linkspector.ymland use the documented schema:dirs: - . ignorePatterns: - pattern: '^https://join\.slack\.com' useGitIgnore: trueUpdate
.github/workflows/validation.yml:- config_file: .github/.linkspector.toml + config_file: .github/.linkspector.yml(Note:
dirs: [.]withuseGitIgnore: truerecursively picks up all tracked*.mdfiles, 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
📒 Files selected for processing (2)
.github/.linkspector.toml.github/workflows/validation.yml
4b483fa to
bea4c1f
Compare
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
📝 Changelog
If this PR introduces user-facing changes, please update the relevant Unreleased section in changelogs: