From ee8cdcf2b2aa373570168cdfd0dbfc17f4d4abec Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 23 Jan 2025 08:45:47 +0200 Subject: [PATCH 1/3] docs: reorganize installation documentation structure --- docs/docs/installation/azure.md | 2 +- docs/docs/installation/bitbucket.md | 4 -- docs/docs/installation/index.md | 12 ++--- docs/docs/installation/pr_agent.md | 49 +++++++++++++++++++ .../{pr_agent_pro.md => qodo_merge.md} | 0 docs/mkdocs.yml | 8 +-- 6 files changed, 58 insertions(+), 17 deletions(-) create mode 100644 docs/docs/installation/pr_agent.md rename docs/docs/installation/{pr_agent_pro.md => qodo_merge.md} (100%) diff --git a/docs/docs/installation/azure.md b/docs/docs/installation/azure.md index 4f38698a..a4ec632b 100644 --- a/docs/docs/installation/azure.md +++ b/docs/docs/installation/azure.md @@ -80,7 +80,7 @@ org = "https://dev.azure.com/YOUR_ORGANIZATION/" # pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication ``` -### Azure DevOps Webhook +## Azure DevOps Webhook To trigger from an Azure webhook, you need to manually [add a webhook](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops). Use the "Pull request created" type to trigger a review, or "Pull request commented on" to trigger any supported comment with / comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported. diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index 58978473..39ce54f1 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -27,10 +27,6 @@ You can get a Bitbucket token for your repository by following Repository Settin Note that comments on a PR are not supported in Bitbucket Pipeline. -## Run using CodiumAI-hosted Bitbucket app 💎 - -Please contact visit [Qodo Merge](https://www.codium.ai/pricing/) if you're interested in a hosted BitBucket app solution that provides full functionality including PR reviews and comment handling. It's based on the [bitbucket_app.py](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/git_providers/bitbucket_provider.py) implementation. - ## Bitbucket Server and Data Center diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index b5956936..ea917d8a 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -4,18 +4,18 @@ If you choose to host your own PR-Agent, you first need to acquire two tokens: 1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). -2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens){:target="_blank"}] +2. A Git personal access token, with the repo scope (GitHub token can be issued from for example [here](https://github.com/settings/tokens){:target="_blank"}) There are several ways to use self-hosted PR-Agent: - [Locally](./locally.md) -- [GitHub](./github.md) -- [GitLab](./gitlab.md) -- [BitBucket](./bitbucket.md) -- [Azure DevOps](./azure.md) +- [GitHub integration](./github.md) +- [GitLab integration](./gitlab.md) +- [BitBucket integration](./bitbucket.md) +- [Azure DevOps integration](./azure.md) ## Qodo Merge 💎 Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
With Qodo Merge, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. -See [here](https://qodo-merge-docs.qodo.ai/installation/pr_agent_pro/) for more details. +See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details. diff --git a/docs/docs/installation/pr_agent.md b/docs/docs/installation/pr_agent.md new file mode 100644 index 00000000..cb6a4092 --- /dev/null +++ b/docs/docs/installation/pr_agent.md @@ -0,0 +1,49 @@ +# PR-Agent Installation Guide + +PR-Agent can be deployed in various environments and platforms. Choose the installation method that best suits your needs: + +## 🖥️ Local Installation + +Learn how to run PR-Agent locally using: + +- Docker image +- pip package +- CLI from source code + +[View Local Installation Guide →](https://qodo-merge-docs.qodo.ai/installation/locally/) + +## 🐙 GitHub Integration + +Set up PR-Agent with GitHub as: + +- GitHub Action +- Local GitHub App + +[View GitHub Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/github/) + +## 🦊 GitLab Integration + +Deploy PR-Agent on GitLab as: + +- GitLab pipeline job +- Local GitLab webhook server + +[View GitLab Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/gitlab/) + +## 🟦 BitBucket Integration + +Implement PR-Agent in BitBucket as: + +- BitBucket pipeline job +- Local BitBucket server + +[View BitBucket Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/bitbucket/) + +## 🔷 Azure DevOps Integration + +Configure PR-Agent with Azure DevOps as: + +- Azure DevOps pipeline job +- Local Azure DevOps webhook + +[View Azure DevOps Integration Guide →](https://qodo-merge-docs.qodo.ai/installation/azure/) \ No newline at end of file diff --git a/docs/docs/installation/pr_agent_pro.md b/docs/docs/installation/qodo_merge.md similarity index 100% rename from docs/docs/installation/pr_agent_pro.md rename to docs/docs/installation/qodo_merge.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5d2d55d6..42ad14df 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -9,12 +9,8 @@ nav: - Data Privacy: 'overview/data_privacy.md' - Installation: - 'installation/index.md' - - Locally: 'installation/locally.md' - - GitHub: 'installation/github.md' - - GitLab: 'installation/gitlab.md' - - BitBucket: 'installation/bitbucket.md' - - Azure DevOps: 'installation/azure.md' - - 💎 Qodo Merge: 'installation/pr_agent_pro.md' + - PR-Agent: 'installation/pr_agent.md' + - 💎 Qodo Merge: 'installation/qodo_merge.md' - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' From e8b8909ab7f63b64184bfba0fcbd1907e758f446 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 23 Jan 2025 08:47:20 +0200 Subject: [PATCH 2/3] docs: update pricing link from codium.ai to qodo.ai --- docs/docs/installation/qodo_merge.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/installation/qodo_merge.md b/docs/docs/installation/qodo_merge.md index 0e6a7f01..2d9b9bf6 100644 --- a/docs/docs/installation/qodo_merge.md +++ b/docs/docs/installation/qodo_merge.md @@ -31,7 +31,7 @@ Qodo Merge for Bitbucket Cloud is available for installation through the followi ### Bitbucket Server -To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.codium.ai/pricing/) trial. +To use Qodo Merge application on your private Bitbucket Server, you will need to contact us for starting an [Enterprise](https://www.qodo.ai/pricing/) trial. ## Install Qodo Merge for GitLab (Teams & Enterprise) From cd5bdf9e5947e5408d5a961ce12b605fc7c6a870 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 23 Jan 2025 08:53:29 +0200 Subject: [PATCH 3/3] docs: reorganize token requirements in installation documentation --- docs/docs/installation/index.md | 6 +----- docs/docs/installation/locally.md | 6 ++++++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/docs/installation/index.md b/docs/docs/installation/index.md index ea917d8a..a697ebdf 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -1,10 +1,6 @@ # Installation ## Self-hosted PR-Agent -If you choose to host your own PR-Agent, you first need to acquire two tokens: - -1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). -2. A Git personal access token, with the repo scope (GitHub token can be issued from for example [here](https://github.com/settings/tokens){:target="_blank"}) There are several ways to use self-hosted PR-Agent: @@ -17,5 +13,5 @@ There are several ways to use self-hosted PR-Agent: ## Qodo Merge 💎 Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
-With Qodo Merge, installation is as simple as signing up and adding the Qodo Merge app to your relevant repo. +With Qodo Merge, installation is as simple as adding the Qodo Merge app to your relevant repo. See [here](https://qodo-merge-docs.qodo.ai/installation/qodo_merge/) for more details. diff --git a/docs/docs/installation/locally.md b/docs/docs/installation/locally.md index 04c4e29b..cd60f076 100644 --- a/docs/docs/installation/locally.md +++ b/docs/docs/installation/locally.md @@ -1,3 +1,9 @@ +To run PR-Agent locally, you first need to acquire two keys: + +1. An OpenAI key from [here](https://platform.openai.com/api-keys){:target="_blank"}, with access to GPT-4 (or a key for other [language models](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/), if you prefer). +2. A personal access token from your Git platform (GitHub, GitLab, BitBucket) with repo scope. GitHub token, for example, can be issued from for example [here](https://github.com/settings/tokens){:target="_blank"} + + ## Using Docker image A list of the relevant tools can be found in the [tools guide](../tools/ask.md).