Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example usage #864

Merged
merged 1 commit into from
Apr 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions docs/docs/tools/describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

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=...
```


## Configuration options
### Automatic invocation

### 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:
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):
```
/describe --pr_description.some_config1=... --pr_description.some_config2=...
[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.
Expand Down
Loading