From 2fc0e462c4aec57d285ccf9f213729555de52aa5 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Sun, 16 Feb 2025 15:36:18 +0200 Subject: [PATCH] docs: update describe tool configuration table with missing options --- docs/docs/tools/describe.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index 88d17e85..0a8cb4a2 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -85,7 +85,19 @@ publish_labels = 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". + 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 the number of files exceeds the threshold defined by `collapsible_file_list_threshold`. Default is "adaptive". + + + collapsible_file_list_threshold + The number of files threshold for when to make the file list collapsible when using 'adaptive' mode. Default is 8. + + + inline_file_summary + Controls where and how file summaries are displayed: +
- 'table': Displays file changes walkthrough table on both "Files changed" and "Conversation" tabs +
- true: Adds a collapsible file comment with changes title and summary for each file +
- false: Shows file changes walkthrough only in the "Conversation" tab +
Default is false. enable_large_pr_handling @@ -95,6 +107,10 @@ publish_labels = true enable_help_text If set to true, the tool will display a help text in the comment. Default is false. + + enable_help_comment + If set to true, the help guidance text is displayed in the comment. Default is true. + enable_override_title_with_parent_tag If set to true, the tool will set the PR title to the next patch version from the latest tag in the target branch, with an RC suffix (e.g., v1.0.1-rc.1). Default is false.