mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-06 22:00:40 +08:00
90 lines
3.9 KiB
Markdown
90 lines
3.9 KiB
Markdown
## Run as a GitLab Pipeline
|
|
You can use a pre-built Action Docker image to run PR-Agent as a GitLab pipeline. This is a simple way to get started with Qodo Merge without setting up your own server.
|
|
|
|
(1) Add the following file to your repository under `.gitlab-ci.yml`:
|
|
```yaml
|
|
stages:
|
|
- pr_agent
|
|
|
|
pr_agent_job:
|
|
stage: pr_agent
|
|
image:
|
|
name: codiumai/pr-agent:latest
|
|
entrypoint: [""]
|
|
script:
|
|
- cd /app
|
|
- echo "Running PR Agent action step"
|
|
- export MR_URL="$CI_MERGE_REQUEST_PROJECT_URL/merge_requests/$CI_MERGE_REQUEST_IID"
|
|
- echo "MR_URL=$MR_URL"
|
|
- export gitlab__url=$CI_SERVER_PROTOCOL://$CI_SERVER_FQDN
|
|
- export gitlab__PERSONAL_ACCESS_TOKEN=$GITLAB_PERSONAL_ACCESS_TOKEN
|
|
- export config__git_provider="gitlab"
|
|
- export openai__key=$OPENAI_KEY
|
|
- python -m pr_agent.cli --pr_url="$MR_URL" describe
|
|
- python -m pr_agent.cli --pr_url="$MR_URL" review
|
|
- python -m pr_agent.cli --pr_url="$MR_URL" improve
|
|
rules:
|
|
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
|
|
```
|
|
This script will run Qodo Merge on every new merge request. You can modify the `rules` section to run Qodo Merge on different events.
|
|
You can also modify the `script` section to run different Qodo Merge commands, or with different parameters by exporting different environment variables.
|
|
|
|
|
|
(2) Add the following masked variables to your GitLab repository (CI/CD -> Variables):
|
|
|
|
- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
|
|
|
|
- `OPENAI_KEY`: Your OpenAI key.
|
|
|
|
Note that if your base branches are not protected, don't set the variables as `protected`, since the pipeline will not have access to them.
|
|
|
|
> **Note**: The `$CI_SERVER_FQDN` variable is available starting from GitLab version 16.10. If you're using an earlier version, this variable will not be available. However, you can combine `$CI_SERVER_HOST` and `$CI_SERVER_PORT` to achieve the same result. Please ensure you're using a compatible version or adjust your configuration.
|
|
|
|
|
|
## Run a GitLab webhook server
|
|
|
|
1. In GitLab create a new user and give it "Reporter" role ("Developer" if using Pro version of the agent) for the intended group or project.
|
|
|
|
2. For the user from step 1. generate a `personal_access_token` with `api` access.
|
|
|
|
3. Generate a random secret for your app, and save it for later (`shared_secret`). For example, you can use:
|
|
|
|
```
|
|
SHARED_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
|
|
```
|
|
|
|
4. Clone this repository:
|
|
|
|
```
|
|
git clone https://github.com/qodo-ai/pr-agent.git
|
|
```
|
|
|
|
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
|
|
1. In the configuration file/variables:
|
|
- Set `config.git_provider` to "gitlab"
|
|
|
|
2. In the secrets file/variables:
|
|
- Set your AI model key in the respective section
|
|
- In the [gitlab] section, set `personal_access_token` (with token from step 2) and `shared_secret` (with secret from step 3)
|
|
|
|
6. Build a Docker image for the app and optionally push it to a Docker repository. We'll use Dockerhub as an example:
|
|
```
|
|
docker build . -t gitlab_pr_agent --target gitlab_webhook -f docker/Dockerfile
|
|
docker push codiumai/pr-agent:gitlab_webhook # Push to your Docker repository
|
|
```
|
|
|
|
7. Set the environmental variables, the method depends on your docker runtime. Skip this step if you included your secrets/configuration directly in the Docker image.
|
|
|
|
```
|
|
"CONFIG.GIT_PROVIDER": "gitlab"
|
|
"GITLAB.PERSONAL_ACCESS_TOKEN": "<personal_access_token>"
|
|
"GITLAB.SHARED_SECRET": "<shared_secret>"
|
|
"GITLAB.URL": "https://gitlab.com"
|
|
"OPENAI.KEY": "<your_openai_api_key>"
|
|
```
|
|
|
|
8. Create a webhook in your GitLab project. Set the URL to ```http[s]://<PR_AGENT_HOSTNAME>/webhook```, the secret token to the generated secret from step 3, and enable the triggers `push`, `comments` and `merge request events`.
|
|
|
|
9. Test your installation by opening a merge request or commenting on a merge request using one of PR Agent's commands.
|
|
|