From 7dfc306e7c95a1a53abcb0b0b00ffe4a6e6159f6 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Mon, 1 Jan 2024 20:10:59 +0200 Subject: [PATCH] feat: Add SOC2 compliance review feature to PR agent --- README.md | 1 + docs/REVIEW.md | 3 +++ pr_agent/settings/configuration.toml | 3 +++ 3 files changed, 7 insertions(+) diff --git a/README.md b/README.md index a528c61c..aa759d5f 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif |-------|---------------------------------------------|:------:|:------:|:---------:| | TOOLS | Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | ⮑ Incremental | :white_check_mark: | | | +| | ⮑ SOC2 Compliance 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Describe | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/REVIEW.md b/docs/REVIEW.md index a63ef47f..9990819d 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -29,6 +29,9 @@ Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings - `remove_previous_review_comment`: if set to true, the tool will remove the previous review comment before adding a new one. Default is false. - `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true. - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". +#### SOC2 compliance 💎 +- `require_soc2_review`: if set to true, the tool will add a section that checks if the PR description includes a link to a ticket in a project management system (e.g., Jira, Asana, Trello, etc.), as required by SOC2 compliance. Default is false. +- `soc2_ticket_prompt`: The prompt to be used for the SOC2 ticket review. Default is "Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?". Edit this field if your compliance requirements are different. #### review labels - `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true. - `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false. diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 53e3b984..04466c72 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -23,6 +23,9 @@ require_score_review=false require_tests_review=true require_security_review=true require_estimate_effort_to_review=true +# soc2 +require_soc2_ticket=false +soc2_ticket_prompt="Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?" # general options num_code_suggestions=4 inline_code_comments = false