Skip to content

docs: sync CLI option metadata and PR review caveats with current behavior #503

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
2bndy5 merged 1 commit into from
Oct 18, 2026
Merged

docs: sync CLI option metadata and PR review caveats with current behavior #503

Show file tree
Hide file tree
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
14 changes: 7 additions & 7 deletions docs/cli.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ inputs:
minimum-version: '1.4.6'
verbosity:
minimum-version: '1.3.0'
mod-sys:
minimum-version: '2.0.0'
no-mod-sys:
minimum-version: '2.0.0'
lines-changed-only:
minimum-version: '1.5.0'
required-permission: 'contents: read #file-changes'
Expand Down Expand Up @@ -39,14 +43,10 @@ inputs:
minimum-version: '1.4.3'
database:
minimum-version: '1.4.0'
extra-args:
extra-arg:
minimum-version: '1.4.7'
tidy-review:
minimum-version: '1.7.0'
experimental: true
required-permission: 'pull-requests: write #pull-request-reviews'
format-review:
minimum-version: '1.7.0'
pr-review:
minimum-version: '2.0.0'
required-permission: 'pull-requests: write #pull-request-reviews'
passive-reviews:
minimum-version: '1.10.0'
Expand Down
6 changes: 4 additions & 2 deletions docs/docs/pr-review-caveats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Clang-tidy and clang-format suggestions are shown in 1 Pull Request review.

- Each generated review is specific to the commit that triggered the Continuous Integration
workflow.
- Suggestions that were already posted in a previous review are not repeated.
If all suggestions were already posted, then no new review is posted.
- Outdated reviews are dismissed and minimized if all suggestions/comments are resolved.
Some clang-tidy findings do not have automatic fixes to suggest. So, some review comments
may need user action to resolve.
Expand All @@ -63,8 +65,8 @@ GitHub REST API does not provide a way to hide comments or mark review suggestio

If any suggestions did not fit within the Pull Request diff, then the review's summary comment will
indicate how many suggestions were left out.
The full patch of suggestions is always included as a collapsed code block in the review summary
comment. This isn't a problem we can fix.
A patch of the suggestions that did not fit is included as a collapsed code block in the review
summary comment (unless the patch is too large to fit in the comment). This isn't a problem we can fix.
GitHub won't allow review comments/suggestions to target lines that are not shown in the Pull
Request diff (the summation of file differences in a Pull Request).

Expand Down
Loading