feat: add option to write summary to file by philippkarg · Pull Request #206 · cpp-linter/cpp-linter

philippkarg · 2026-06-26T13:50:43Z

Closes #205.

Use option -o or --summary-output-file to provide a file.
By default the summary will not be written to a file.
If the provided path is a directory, log an error.

Summary by CodeRabbit

New Features
- Added -o/--summary-output-file to write the generated step summary to a specified Markdown file path (use an empty value to disable file output).
Bug Fixes
- Feedback summaries are now produced when built-in step summaries are enabled and/or when a summary output file is provided.
- When using a summary output file, missing parent directories are created and write errors are handled without crashing.
Tests
- Expanded CLI argument parsing and feedback/comment tests to cover summary file creation and edge cases.

coderabbitai · 2026-06-26T13:53:54Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

The PR adds a --summary-output-file CLI option, stores it on Args, and updates GithubApiClient.post_feedback to write generated summary text to GITHUB_STEP_SUMMARY and an optional file path. Tests cover parsing and file-writing behavior.

Changes

Summary output file support

Layer / File(s)	Summary
CLI option and parser tests `cpp_linter/cli.py`, `tests/test_cli_args.py`	`Args` defines `summary_output_file`, `_parser_args` accepts `-o/--summary-output-file`, and parser tests cover a filename value and an empty value.
Summary output writing `cpp_linter/rest_api/github_api.py`, `tests/comments/test_comments.py`	`post_feedback` computes whether to write the step summary, appends the generated comment to `GITHUB_STEP_SUMMARY`, writes the same comment to `args.summary_output_file`, and tests cover writable-file and directory-path cases.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding an option to write the summary to a file.
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.

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.}

coderabbitai

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 `@cpp_linter/rest_api/github_api.py`:
- Around line 242-251: The optional summary file write in the `post_feedback()`
flow can raise an `OSError` and abort annotations when
`args.summary_output_file` is invalid or its parent directory is missing. Wrap
the `summary_output_path.open(...)` write path in a best-effort `try/except
OSError` inside the `summary_output_path` handling block, and log the failure
with `log_commander.error` while allowing the rest of `post_feedback()` to
continue. Keep the existing `Path` and `summary_output_path.is_dir()` checks,
and ensure only the extra file output is skipped on failure.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3a646e43-3e67-48fd-8775-ba7ae53eba84

📥 Commits

Reviewing files that changed from the base of the PR and between c68104c and 670dfed.

📒 Files selected for processing (4)

cpp_linter/cli.py
cpp_linter/rest_api/github_api.py
tests/comments/test_comments.py
tests/test_cli_args.py

2bndy5

The test CI seems to be failing for a separate reason. @shenxianpeng Can you update the CI for the breaking CLI changes in clang-tools-pip v1?

2bndy5

One last tweak.

I'll have to fix the test CI in a separate PR and rebase this branch when that's merged.

- Use option `-o` or `--summary-output-file` to provide a file. - By default the summary will not be written to a file. - If the provided path is a directory, log an error.

Co-authored-by: Brendan <2bndy5@gmail.com>

- Catch OSErrors when writing the summary output file.} - Log the errors, but don't stop the workflow.

shenxianpeng · 2026-06-26T19:28:11Z

The test CI seems to be failing for a separate reason. @shenxianpeng Can you update the CI for the breaking CLI changes in clang-tools-pip v1?

Just see your comment right now after the CI failure was fixed 😅

philippkarg · 2026-06-26T19:43:17Z

Ahh I fucked up the import sorting in my last commit. Let me fix that

codecov · 2026-06-26T19:43:39Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.31%. Comparing base (eaaa671) to head (cabd3a2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #206      +/-   ##
==========================================
+ Coverage   98.29%   98.31%   +0.01%     
==========================================
  Files          24       24              
  Lines        1938     1958      +20     
==========================================
+ Hits         1905     1925      +20     
  Misses         33       33

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

also updates the --help output about the `--summary-output-file`

2bndy5

Great work team!

I added some polish to --help output about relative paths and catching encoding errors (with ValueError)

slated for v1.13.0

2bndy5 · 2026-06-26T20:17:08Z

New CLI doc looks good too: https://cpp-linter--206.org.readthedocs.build/en/206/cli_args.html#cmdoption-o

ref - cpp-linter/cpp-linter#205 - cpp-linter/cpp-linter#206 Allows exporting the step summary comment to a custom file path. Useful as a workaround for contexts with restricted permissions (eg private repos).  ## Summary by CodeRabbit * **New Features** * Added a new CLI option to save the generated summary to a file. * Summary files can use either an absolute path or a path relative to the repository root. * **Bug Fixes** * Summary content is now generated whenever file output is requested, even if step-based summary posting is off. * Improved error reporting for file and directory write failures.

coderabbitai Bot reviewed Jun 26, 2026

View reviewed changes

Comment thread cpp_linter/rest_api/github_api.py Outdated

philippkarg marked this pull request as draft June 26, 2026 13:59

2bndy5 requested changes Jun 26, 2026

View reviewed changes

Comment thread cpp_linter/cli.py Outdated

Comment thread cpp_linter/rest_api/github_api.py Outdated

github-advanced-security AI found potential problems Jun 26, 2026

View reviewed changes

Comment thread cpp_linter/rest_api/github_api.py Fixed

philippkarg marked this pull request as ready for review June 26, 2026 15:05

philippkarg changed the title ~~feat: Add option to write summary to file.~~ feat: Add option to write summary to file Jun 26, 2026

philippkarg changed the title ~~feat: Add option to write summary to file~~ feat: add option to write summary to file Jun 26, 2026

2bndy5 requested changes Jun 26, 2026

View reviewed changes

Comment thread cpp_linter/rest_api/github_api.py Outdated

Copilot AI mentioned this pull request Jun 26, 2026

fix(ci): use correct clang-tools subcommand syntax #208

Closed

Philipp Karg and others added 5 commits June 26, 2026 21:25

feat: Add option to write summary to file.

6cb9072

- Use option `-o` or `--summary-output-file` to provide a file. - By default the summary will not be written to a file. - If the provided path is a directory, log an error.

chore: Improve help text for CLI argument.

b4f720a

Co-authored-by: Brendan <2bndy5@gmail.com>

fix: Improve summary output file error handling.

1e9c0b3

- Catch OSErrors when writing the summary output file.} - Log the errors, but don't stop the workflow.

fix: resolve summary output file to absolute path

64f005b

refactor: use write_text() instead of write

7ee169f

shenxianpeng force-pushed the feat/add-summary-output-path branch from c42596c to 7ee169f Compare June 26, 2026 19:25

shenxianpeng temporarily deployed to test-coverage June 26, 2026 19:41 — with GitHub Actions Inactive

chore: undo import sorting

e5ed513

philippkarg temporarily deployed to test-coverage June 26, 2026 19:59 — with GitHub Actions Inactive

fix: catch any encoding error with ValueError

ef62207

also updates the --help output about the `--summary-output-file`

2bndy5 approved these changes Jun 26, 2026

View reviewed changes

docs: note new feature's required version

cabd3a2

slated for v1.13.0

2bndy5 temporarily deployed to test-coverage June 26, 2026 20:22 — with GitHub Actions Inactive

2bndy5 merged commit e8981d1 into cpp-linter:main Jun 26, 2026
39 checks passed

2bndy5 added enhancement New feature or request minor A minor version bump labels Jun 26, 2026

2bndy5 mentioned this pull request Jun 27, 2026

feat: add option for custom path to summary comment output cpp-linter/cpp-linter-rs#388

Merged

philippkarg mentioned this pull request Jun 27, 2026

feat: add summary output file input cpp-linter/cpp-linter-action#455

Merged

Uh oh!

Uh oh!

Conversation

philippkarg commented Jun 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

2bndy5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

2bndy5 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shenxianpeng commented Jun 26, 2026

Uh oh!

philippkarg commented Jun 26, 2026

Uh oh!

codecov Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

2bndy5 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

2bndy5 commented Jun 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

philippkarg commented Jun 26, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading

codecov Bot commented Jun 26, 2026 •

edited

Loading

2bndy5 left a comment •

edited

Loading