Describe Tool

The describe tool scans the PR code changes, and automatically generates PR description - title, type, summary, walkthrough and labels. It can be invoked manually by commenting on any PR:

/describe

For example:

The describe tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for GitHub App and GitHub Action

Handle custom labels from the Repo's labels page 💎

This feature is available only in PR-Agent Pro

GitHub : https://github.com/{owner}/{repo}/labels, or click on the "Labels" tab in the issues or PRs page.
GitLab : https://gitlab.com/{owner}/{repo}/-/labels, or click on "Manage" -> "Labels" on the left menu.

b. Add/edit the custom labels. It should be formatted as follows:

Label name: The name of the custom label.
Description: Start the description of with prefix pr_agent:, for example: pr_agent: Description of when AI should suggest this label.
The description should be comprehensive and detailed, indicating when to add the desired label.

c. Now the custom labels will be included in the generate_labels tool.

*This feature is supported in GitHub and GitLab.

Configuration options

Under the section 'pr_description', the configuration file contains options to customize the 'describe' tool:

publish_labels: if set to true, the tool will publish the labels to the PR. Default is true.
publish_description_as_comment: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false.
add_original_user_description: if set to true, the tool will add the original user description to the generated description. Default is false.
keep_original_user_title: if set to true, the tool will keep the original PR title, and won't change it. Default is false.
extra_instructions: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
To enable custom labels, apply the configuration changes described here
enable_pr_type: if set to false, it will not show the PR type as a text value in the description content. Default is true.
final_update_message: if set to true, it will add a comment message PR Description updated to latest commit... after finishing calling /describe. Default is true.
enable_semantic_files_types: if set to true, "PR changes walkthrough" section will be generated. Default is true.

Markers template

markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.

For example, if the PR original description was:

User content...


## PR Description:
pr_agent:summary

## PR Walkthrough:
pr_agent:walkthrough

The marker pr_agent:summary will be replaced with the PR summary, and pr_agent:walkthrough will be replaced with the PR walkthrough.

Example:

        env:
          pr_description.use_description_markers: 'true'

==>

Configuration params:

use_description_markers: if set to true, the tool will use markers template. It replaces every marker of the form pr_agent:marker_name with the relevant content. Default is false.
include_generated_by_header: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.

4.2 KiB Raw Blame History