From a0dc9deb30e8c0ec3acaab27e9c6a50bf80ab5d4 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 23 Feb 2025 08:15:14 +0200 Subject: [PATCH] docs: add auto-approval configuration documentation --- docs/docs/tools/improve.md | 38 ++++++++++++++++++++++++++++ docs/docs/tools/review.md | 27 -------------------- pr_agent/settings/configuration.toml | 8 +++--- 3 files changed, 43 insertions(+), 30 deletions(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index b00ea66c..ab1e6bb9 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -311,6 +311,44 @@ code_suggestions_self_review_text = "... (your text here) ..." To prevent unauthorized approvals, this configuration defaults to false, and cannot be altered through online comments; enabling requires a direct update to the configuration file and a commit to the repository. This ensures that utilizing the feature demands a deliberate documented decision by the repository owner. +### Auto-approval + +Under specific conditions, Qodo Merge can auto-approve a PR when a specific comment is invoked, or when the PR meets certain criteria. + +To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set, in a pre-defined _configuration file_, the following: +```toml +[config] +enable_auto_approval = true +``` +Note that this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository. +This ensures that enabling auto-approval is a deliberate decision by the repository owner. + +**(1) Auto-approval by commenting** + +After enabling, by commenting on a PR: +``` +/review auto_approve +``` +Qodo Merge will automatically approve the PR, and add a comment with the approval. + +**(2) Auto-approval when the PR meets certain criteria** + +There are two criteria that can be set for auto-approval: + +- **Review effort score** +```toml +[config] +auto_approve_for_low_review_effort = X # X is a number between 1 to 5 +``` +When the [review effort score](https://www.qodo.ai/images/pr_agent/review3.png) is lower or equal to X, the PR will be auto-approved. + +___ +- **No code suggestions** +```toml +[config] +auto_approve_for_no_suggestions = true +``` +When no [code suggestion](https://www.qodo.ai/images/pr_agent/code_suggestions_as_comment_closed.png) were found for the PR, the PR will be auto-approved. ### How many code suggestions are generated? Qodo Merge uses a dynamic strategy to generate code suggestions based on the size of the pull request (PR). Here's how it works: diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index 6ce96696..e3c3c3c6 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -114,16 +114,6 @@ You can enable\disable the `review` tool to add specific labels to the PR: -!!! example "Auto-approval" - -If enabled, the `review` tool can approve a PR when a specific comment, `/review auto_approve`, is invoked. - - - - - - -
enable_auto_approvalIf set to true, the tool will approve the PR when invoked with the 'auto_approve' command. Default is false. This flag can be changed only from a configuration file.
## Usage Tips @@ -175,23 +165,6 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. -!!! tip "Auto-approval" - - Qodo Merge can approve a PR when a specific comment is invoked. - - To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: - ``` - [pr_reviewer] - enable_auto_approval = true - ``` - (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) - - - After enabling, by commenting on a PR: - ``` - /review auto_approve - ``` - Qodo Merge will automatically approve the PR, and add a comment with the approval. !!! tip "Code suggestions" diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index ad09243a..890cff35 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -48,6 +48,11 @@ ignore_pr_authors = [] # authors to ignore from PR agent when an PR is created # is_auto_command = false # will be auto-set to true if the command is triggered by an automation enable_ai_metadata = false # will enable adding ai metadata +# auto approval 💎 +enable_auto_approval=false # Set to true to enable auto-approval of PRs under certain conditions +auto_approve_for_low_review_effort=-1 # -1 to disable, [1-5] to set the threshold for auto-approval +auto_approve_for_no_suggestions=false # If true, the PR will be auto-approved if there are no suggestions + [pr_reviewer] # /review # # enable/disable features @@ -70,9 +75,6 @@ minimal_commits_for_incremental_review=0 minimal_minutes_for_incremental_review=0 enable_intro_text=true enable_help_text=false # Determines whether to include help text in the PR review. Enabled by default. -# auto approval -enable_auto_approval=false - [pr_description] # /describe # publish_labels=false