Skip to content

docs: add cross-reference to cpp-linter-action #239

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

Merged
shenxianpeng merged 1 commit into from
Jun 8, 2026
Merged

docs: add cross-reference to cpp-linter-action #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,16 @@ this project also provides `clang-tidy`, compile database discovery, explicit
tool-version selection, and richer diagnostics. See the [FAQ](#faq) for the full
comparison.

> [!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.

## Table of Contents

- [Why cpp-linter-hooks?](#why-cpp-linter-hooks)
- [GitHub Actions? Try cpp-linter-action](#github-actions-try-cpp-linter-action)

@coderabbitai coderabbitai Bot Jun 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

🧩 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.md

Repository: 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 || true

Repository: 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 || true

Repository: 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 || true

Repository: 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

- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [Custom Configuration Files](#custom-configuration-files)
Expand Down
Loading