From 472646ddfdabb3b64a3b36c3f933750785066a78 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 17 Jan 2024 16:27:07 +0200 Subject: [PATCH 1/3] Readme --- README.md | 2 ++ docs/DESCRIBE.md | 10 ++++++++++ pr_agent/settings/configuration.toml | 1 + 3 files changed, 13 insertions(+) diff --git a/README.md b/README.md index e7626c47..0411888c 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ We are very happy to share our new paper: Go checkout our official implementation [here](https://github.com/Codium-ai/AlphaCodium) ### Jan 17, 2024 +- 💎 Inline file summary - The `describe` tool now supports a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) - The `improve` tool now can present suggestion in a nice collapsible format, which significantly reduces the PR footprint. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md#summarized-vs-commitable-code-suggestions) for more details. - To accompany the improved interface of the `improve` tool, we change the [default automation settings](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L116) of our GithupApp to: ``` @@ -157,6 +158,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d | | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-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: | +| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index abc937de..83c6defb 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -48,6 +48,16 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related - `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true. - `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive". +### Inline file summary 💎 +To enable inline file summary, set `pr_description.inline_file_summary=true` in the configuration file. + +When the feature is enabled, PR-Agent Pro will add a collapsable summary of each file change in the "Files changed" tab. +This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view). + + + +*Note that this feature is currently available only for GitHub. + ### Handle custom labels from the Repo's labels page :gem: > This feature is available only in PR-Agent Pro diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 5b74d0a3..57aa9e84 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -56,6 +56,7 @@ enable_help_text=true ## changes walkthrough section enable_semantic_files_types=true collapsible_file_list='adaptive' # true, false, 'adaptive' +inline_file_summary=true # Pro feature # markers use_description_markers=false include_generated_by_header=true From 3be7bfce7979eabebbd6bf24e47aeb6841a3c6c1 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 17 Jan 2024 16:33:48 +0200 Subject: [PATCH 2/3] feat: Add repository labels retrieval function in gitlab_provider.py docs: Update links and add Inline file summary to TOC in DESCRIBE.md --- README.md | 4 ++-- docs/DESCRIBE.md | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0411888c..a307391a 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ We are very happy to share our new paper: Go checkout our official implementation [here](https://github.com/Codium-ai/AlphaCodium) ### Jan 17, 2024 -- 💎 Inline file summary - The `describe` tool now supports a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) +- 💎 Inline file summary - The `describe` tool has a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) - The `improve` tool now can present suggestion in a nice collapsible format, which significantly reduces the PR footprint. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md#summarized-vs-commitable-code-suggestions) for more details. - To accompany the improved interface of the `improve` tool, we change the [default automation settings](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L116) of our GithupApp to: ``` @@ -158,7 +158,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d | | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-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: | -| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/Describe.md#inline-file-summary) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| | ⮑ [Inline file summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: | | | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 83c6defb..019d39c6 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -2,6 +2,7 @@ ## Table of Contents - [Overview](#overview) - [Configuration options](#configuration-options) + - [Inline file summary 💎](#inline-file-summary-) - [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem) - [Markers template](#markers-template) - [Usage Tips](#usage-tips) From 3fb6d1733897021205f8e3d564fdc71c76a51ed5 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Wed, 17 Jan 2024 16:36:26 +0200 Subject: [PATCH 3/3] width --- docs/DESCRIBE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 019d39c6..f6c7041f 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -55,7 +55,7 @@ To enable inline file summary, set `pr_description.inline_file_summary=true` in When the feature is enabled, PR-Agent Pro will add a collapsable summary of each file change in the "Files changed" tab. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view). - + *Note that this feature is currently available only for GitHub.