From 4739fd3d37c6816400d096a8c78dc66e54df6247 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Mon, 11 Mar 2024 09:13:35 +0200 Subject: [PATCH] readme --- README.md | 2 +- docs/docs/index.md | 2 +- docs/docs/installation/github.md | 2 +- docs/docs/installation/gitlab.md | 6 +++++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a09b341f..da5159c4 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ CodiumAI PR-Agent is an open-source tool to help efficiently review and handle p - See the [Usage Guide](https://pr-agent-docs.codium.ai/usage-guide/) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. -- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools (tools are run via the commands). +- See the [Tools Guide](https://pr-agent-docs.codium.ai/tools/) for a detailed description of the different tools. Supported commands per platform: diff --git a/docs/docs/index.md b/docs/docs/index.md index f604fd25..caa52ded 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -6,7 +6,7 @@ CodiumAI PR-Agent is an open-source tool to help efficiently review and handle p - See the [Usage Guide](./usage-guide/index.md) for instructions on running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened. -- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools (tools are run via the commands). +- See the [Tools Guide](./tools/index.md) for a detailed description of the different tools. ## PR-Agent Features diff --git a/docs/docs/installation/github.md b/docs/docs/installation/github.md index 9cd2f7e6..dcc624d9 100644 --- a/docs/docs/installation/github.md +++ b/docs/docs/installation/github.md @@ -157,7 +157,7 @@ docker push codiumai/pr-agent:github_app # Push to your Docker repository ## Deploy as a Lambda Function -1. Follow steps 1-5 of [Method 5](#run-as-a-github-app). +1. Follow steps 1-5 from [here](#run-as-a-github-app). 2. Build a docker image that can be used as a lambda function ```shell docker buildx build --platform=linux/amd64 . -t codiumai/pr-agent:serverless -f docker/Dockerfile.lambda diff --git a/docs/docs/installation/gitlab.md b/docs/docs/installation/gitlab.md index e768e850..cb3b7931 100644 --- a/docs/docs/installation/gitlab.md +++ b/docs/docs/installation/gitlab.md @@ -1,16 +1,20 @@ ## Run a GitLab webhook server 1. From the GitLab workspace or group, create an access token. Enable the "api" scope only. + 2. Generate a random secret for your app, and save it for later. For example, you can use: ``` WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))") ``` -3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [Method 5](#run-as-a-github-app) steps 4-7. +3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from [here](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) steps 4-7. + 4. In the secrets file, fill in the following: - Your OpenAI key. - In the [gitlab] section, fill in personal_access_token and shared_secret. The access token can be a personal access token, or a group or project access token. - Set deployment_type to 'gitlab' in [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) + 5. Create a webhook in GitLab. Set the URL to the URL of your app's server. Set the secret token to the generated secret from step 2. In the "Trigger" section, check the ‘comments’ and ‘merge request events’ boxes. + 6. Test your installation by opening a merge request or commenting or a merge request using one of CodiumAI's commands. \ No newline at end of file