From af9b2230a443e7fc81312e2d31a44b542b198ade Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Sun, 18 Oct 2026 21:51:34 +0000 Subject: [PATCH] docs: sync CLI option metadata and PR review caveats with current behavior --- docs/cli.yml | 14 +++++++------- docs/docs/pr-review-caveats.md | 6 ++++-- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/cli.yml b/docs/cli.yml index c06e354e..b50b4baa 100644 --- a/docs/cli.yml +++ b/docs/cli.yml @@ -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' @@ -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' diff --git a/docs/docs/pr-review-caveats.md b/docs/docs/pr-review-caveats.md index 5b843d87..ddc1c123 100644 --- a/docs/docs/pr-review-caveats.md +++ b/docs/docs/pr-review-caveats.md @@ -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. @@ -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).