diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 777e13a9..ce908e5f 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -13,6 +13,20 @@ 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action) +### Git provider's native labels page +> This feature is available only in Pr-Agent Pro :gem: +* 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: Description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this 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](./../pr_agent/settings/configuration.toml#L28) contains options to customize the 'describe' tool: diff --git a/docs/GENERATE_CUSTOM_LABELS.md b/docs/GENERATE_CUSTOM_LABELS.md index a0cf84d6..2f7470e4 100644 --- a/docs/GENERATE_CUSTOM_LABELS.md +++ b/docs/GENERATE_CUSTOM_LABELS.md @@ -24,7 +24,8 @@ To enable custom labels, you need to apply the [configuration changes](#configur #### 2. GitHub Action and GitHub App To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the local `.pr_agent.toml` file in you repository. -#### 3. Git provider's native labels page (Pr-Agent Pro feature :gem:) +#### 3. Git provider's native labels page +> This feature is available only in Pr-Agent Pro :gem: To enable custom labels, you can add/edit the custom labels in the Git provider's native labels page. For example, in GitHub, you can add/edit the labels in the Labels page: a. Go to the Labels page: * Github : https://github.com/{owner}/{repo}/labels, or click on the "Labels" tab in the issues or PRs page.