docs: add cross-reference to cpp-linter-action#239
Merged
Conversation
github-actions
Bot
added
the
documentation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #239 +/- ##
=======================================
Coverage 97.07% 97.07%
=======================================
Files 4 4
Lines 239 239
=======================================
Hits 232 232
Misses 7 7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
WalkthroughThis PR updates ChangesGitHub Actions Companion Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
🚥 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 41: The TOC entry "GitHub Actions? Try cpp-linter-action" points to a
missing anchor; update README.md by converting the existing [!TIP] block into a
proper section with a matching heading (e.g., add a level-2 heading "## GitHub
Actions? Try cpp-linter-action" immediately above the TIP content) or change the
TOC entry to match the actual heading used; ensure the heading text exactly
matches the TOC anchor so the link `#github-actions-try-cpp-linter-action`
resolves.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## Table of Contents | ||
|
|
||
| - [Why cpp-linter-hooks?](#why-cpp-linter-hooks) | ||
| - [GitHub Actions? Try cpp-linter-action](#github-actions-try-cpp-linter-action) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Search for heading that would generate the anchor `#github-actions-try-cpp-linter-action`
# Test: Search for heading. Expect: No matching heading found.
rg -n '^#{1,6}\s+.*GitHub Actions.*cpp-linter-action' README.mdRepository: cpp-linter/cpp-linter-hooks
Length of output: 53
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== README.md lines 25-50 =="
nl -ba README.md | sed -n '25,50p'
echo
echo "== Headings containing 'cpp-linter-action' =="
rg -n '^#{1,6}\s+.*cpp-linter-action' README.md || true
echo
echo "== Headings containing 'GitHub Actions' =="
rg -n '^#{1,6}\s+.*GitHub Actions' README.md || true
echo
echo "== Any explicit anchor/id matching the TOC fragment? =="
rg -n '(github-actions-try-cpp-linter-action|`#github-actions-try-cpp-linter-action`|id=["'\'']github-actions-try-cpp-linter-action)' README.md || trueRepository: cpp-linter/cpp-linter-hooks
Length of output: 160
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== README.md lines 30-45 (around TOC entry) =="
awk 'NR>=30 && NR<=45 {printf "%4d: %s\n", NR, $0}' README.md
echo
echo "== Markdown headings mentioning 'cpp-linter-action' (any level) =="
rg -n '^#{1,6}\s+.*cpp-linter-action' README.md || true
echo
echo "== Markdown headings mentioning 'GitHub Actions' (any level) =="
rg -n '^#{1,6}\s+.*GitHub Actions' README.md || true
echo
echo "== Explicit anchors/ids that match the TOC fragment =="
rg -n '(github-actions-try-cpp-linter-action|id\s*=\s*["'\'']github-actions-try-cpp-linter-action["'\''])' README.md || trueRepository: cpp-linter/cpp-linter-hooks
Length of output: 1104
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== All Markdown headings in README.md =="
rg -n '^#{1,6}\s+' README.md
echo
echo "== Headings mentioning 'Actions' =="
rg -n '^#{1,6}\s+.*Actions' README.md || true
echo
echo "== Headings mentioning 'Try' and 'cpp-linter-action' =="
rg -n '^#{1,6}\s+.*Try.*cpp-linter-action' README.md || trueRepository: cpp-linter/cpp-linter-hooks
Length of output: 848
Broken TOC link: GitHub Actions? Try cpp-linter-action points to a non-existent anchor
The Table of Contents entry links to #github-actions-try-cpp-linter-action, but README.md contains no corresponding ## GitHub Actions? Try cpp-linter-action heading—only a [!TIP] blockquote—so clicking the TOC item won’t navigate anywhere.
🔗 Recommended fix: Convert the TIP into a proper section
-
-> [!TIP]
-> Using GitHub Actions for CI? Check out
-> **[cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)** —
-> our companion GitHub Action that runs the same tools in CI with rich PR reviews,
-> thread comments, step summaries, and file annotations.
-
+
+## GitHub Actions? Try cpp-linter-action
+
+Using GitHub Actions for CI? Check out **[cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)** — our companion GitHub Action that runs the same tools in CI with rich PR reviews, thread comments, step summaries, and file annotations.
+🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 41-41: Link fragments should be valid
(MD051, link-fragments)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 41, The TOC entry "GitHub Actions? Try cpp-linter-action"
points to a missing anchor; update README.md by converting the existing [!TIP]
block into a proper section with a matching heading (e.g., add a level-2 heading
"## GitHub Actions? Try cpp-linter-action" immediately above the TIP content) or
change the TOC entry to match the actual heading used; ensure the heading text
exactly matches the TOC anchor so the link
`#github-actions-try-cpp-linter-action` resolves.
Source: Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a TIP callout in the README recommending cpp-linter-action for users who want GitHub Actions CI integration, with bidirectional cross-linking between the two projects.
Summary by CodeRabbit