xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-07 14:20:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Example usage

Browse Source
This commit is contained in:
mrT23
2024-04-17 09:02:54 +03:00
parent a134a8bf6d
commit 6c78f4fd88
1 changed files with 32 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/docs/tools/describe.md
View File

@ -6,22 +6,47 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
/describe
```
For example:
## Example usage
### Manual invocation
Invoke the tool manually by commenting `/describe` on any PR:
![Describe comment](https://codium.ai/images/pr_agent/describe_comment.png){width=512}
After ~30 seconds, the tool will generate a description for the PR:
![Describe New](https://codium.ai/images/pr_agent/describe_new.png){width=512}
## Configuration options
### General configurations
To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template:
If you want to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46), add the relevant ones to the command:
```
/describe --pr_description.some_config1=... --pr_description.some_config2=...
```
### Automatic invocation
To run the `describe` automatically when a PR is opened, define in a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/#wiki-configuration-file):
```
[github_app]
pr_commands = [
"/describe",
...
]
[pr_description]
publish_labels = ...
...
```
- The `pr_commands` lists commands that will be executed on every PR.
- The `[pr_description]` section contains the configurations for the `describe` tool you want to edit.
## Configuration options
### General configurations
!!! example "Possible configurations"
- `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.