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

Update GitLab configuration and documentation for webhook setup

Browse Source
This commit is contained in:
mrT23
2024-02-21 09:20:28 +02:00
parent 0e3417b4ab
commit 275f0d6a05
3 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Usage.md
View File

@ -6,6 +6,7 @@
- [Online Usage](#online-usage) - [Online Usage](#online-usage)
- [GitHub App](#working-with-github-app) - [GitHub App](#working-with-github-app)
- [GitHub Action](#working-with-github-action) - [GitHub Action](#working-with-github-action)
- [GitLab Webhook](#working-with-gitlab-webhook)
- [BitBucket App](#working-with-bitbucket-self-hosted-app) - [BitBucket App](#working-with-bitbucket-self-hosted-app)
- [Azure DevOps Provider](#azure-devops-provider) - [Azure DevOps Provider](#azure-devops-provider)
- [Additional Configurations Walkthrough](#appendix---additional-configurations-walkthrough) - [Additional Configurations Walkthrough](#appendix---additional-configurations-walkthrough)
@ -237,6 +238,16 @@ For example, you can set an environment variable: `pr_description.add_original_u
[pr_description] [pr_description]
add_original_user_description = false add_original_user_description = false
``` ```
### Working with GitLab Webhook
After setting up a GitLab webhook, to control which commands will run automatically when a new PR is opened, you can set the `pr_commands` parameter in the configuration file, similar to the GitHub App:
```
[gitlab]
pr_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
"/review --pr_reviewer.num_code_suggestions=0",
"/improve",
]
```
### Working with BitBucket Self-Hosted App ### Working with BitBucket Self-Hosted App
Similar to GitHub app, when running PR-Agent from BitBucket App, the default [configuration file](pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded. Similar to GitHub app, when running PR-Agent from BitBucket App, the default [configuration file](pr_agent/settings/configuration.toml) from a pre-built docker will be initially loaded.

2
pr_agent/servers/gitlab_webhook.py
View File

@ -32,7 +32,7 @@ def handle_request(background_tasks: BackgroundTasks, url: str, body: str, log_c
async def _perform_commands_gitlab(commands_conf: str, agent: PRAgent, body: dict, api_url: str, log_context: dict): async def _perform_commands_gitlab(commands_conf: str, agent: PRAgent, body: dict, api_url: str, log_context: dict):
apply_repo_settings(api_url) apply_repo_settings(api_url)
commands = get_settings().get(f"azure_devops_server.{commands_conf}") commands = get_settings().get(f"gitlab.{commands_conf}")
for command in commands: for command in commands:
split_command = command.split(" ") split_command = command.split(" ")
command = split_command[0] command = split_command[0]

17
pr_agent/settings/configuration.toml
View File

@ -171,17 +171,12 @@ push_commands = [
] ]
[gitlab] [gitlab]
# URL to the gitlab service url = "https://gitlab.com" # URL to the gitlab service
url = "https://gitlab.com" pr_commands = [
"/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
# Polling (either project id or namespace/project_name) syntax can be used "/review --pr_reviewer.num_code_suggestions=0",
projects_to_monitor = ['org_name/repo_name'] "/improve --pr_code_suggestions.summarize=true",
]
# Polling trigger
magic_word = "AutoReview"
# Polling interval
polling_interval_seconds = 30
[bitbucket_app] [bitbucket_app]
#auto_review = true # set as config var in .pr_agent.toml #auto_review = true # set as config var in .pr_agent.toml