mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-04 21:00:40 +08:00
docs: reorganize installation documentation structure
This commit is contained in:
@ -80,7 +80,7 @@ org = "https://dev.azure.com/YOUR_ORGANIZATION/"
|
|||||||
# pat = "YOUR_PAT_TOKEN" needed only if using PAT for authentication
|
# 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).
|
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 /<command> <args> comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported.
|
Use the "Pull request created" type to trigger a review, or "Pull request commented on" to trigger any supported comment with /<command> <args> comment on the relevant PR. Note that for the "Pull request commented on" trigger, only API v2.0 is supported.
|
||||||
|
@ -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.
|
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
|
## Bitbucket Server and Data Center
|
||||||
|
|
||||||
|
@ -4,18 +4,18 @@
|
|||||||
If you choose to host your own PR-Agent, you first need to acquire two tokens:
|
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).
|
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:
|
There are several ways to use self-hosted PR-Agent:
|
||||||
|
|
||||||
- [Locally](./locally.md)
|
- [Locally](./locally.md)
|
||||||
- [GitHub](./github.md)
|
- [GitHub integration](./github.md)
|
||||||
- [GitLab](./gitlab.md)
|
- [GitLab integration](./gitlab.md)
|
||||||
- [BitBucket](./bitbucket.md)
|
- [BitBucket integration](./bitbucket.md)
|
||||||
- [Azure DevOps](./azure.md)
|
- [Azure DevOps integration](./azure.md)
|
||||||
|
|
||||||
## Qodo Merge 💎
|
## Qodo Merge 💎
|
||||||
Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
|
Qodo Merge, an app hosted by QodoAI for GitHub\GitLab\BitBucket, is also available.
|
||||||
<br>
|
<br>
|
||||||
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 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.
|
||||||
|
49
docs/docs/installation/pr_agent.md
Normal file
49
docs/docs/installation/pr_agent.md
Normal file
@ -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/)
|
@ -9,12 +9,8 @@ nav:
|
|||||||
- Data Privacy: 'overview/data_privacy.md'
|
- Data Privacy: 'overview/data_privacy.md'
|
||||||
- Installation:
|
- Installation:
|
||||||
- 'installation/index.md'
|
- 'installation/index.md'
|
||||||
- Locally: 'installation/locally.md'
|
- PR-Agent: 'installation/pr_agent.md'
|
||||||
- GitHub: 'installation/github.md'
|
- 💎 Qodo Merge: 'installation/qodo_merge.md'
|
||||||
- GitLab: 'installation/gitlab.md'
|
|
||||||
- BitBucket: 'installation/bitbucket.md'
|
|
||||||
- Azure DevOps: 'installation/azure.md'
|
|
||||||
- 💎 Qodo Merge: 'installation/pr_agent_pro.md'
|
|
||||||
- Usage Guide:
|
- Usage Guide:
|
||||||
- 'usage-guide/index.md'
|
- 'usage-guide/index.md'
|
||||||
- Introduction: 'usage-guide/introduction.md'
|
- Introduction: 'usage-guide/introduction.md'
|
||||||
|
Reference in New Issue
Block a user