mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-02 11:50:37 +08:00
fix broken links
This commit is contained in:
Almog Lavi
@ -16,19 +16,19 @@ PR-Agent offers extensive pull request functionalities across various git provid
|
||||
|-------|---------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:|
|
||||
| TOOLS | Review | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | ⮑ Incremental | ✔️ | | | |
|
||||
| | ⮑ [SOC2 Compliance](/tools/REVIEW/#soc2-ticket-compliance){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | ⮑ [SOC2 Compliance](./tools/review.md#soc2-ticket-compliance-💎){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Ask | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Describe | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | ⮑ [Inline file summary](/tools//DESCRIBE/#inline-file-summary){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | ⮑ [Inline file summary](./tools/describe.md#inline-file-summary-💎){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Improve | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | ⮑ Extended | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Custom Suggestions](/tools/CUSTOM_SUGGESTIONS/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Custom Suggestions](./tools/custom_suggestions.md){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Reflect and Review | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Update CHANGELOG.md | ✔️ | ✔️ | ✔️ | ️ |
|
||||
| | Find Similar Issue | ✔️ | | | ️ |
|
||||
| | [Add PR Documentation](/tools/DOCUMENTATION/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Generate Custom Labels](/tools/DESCRIBE/#handle-custom-labels-from-the-repos-labels-page-gem){:target="_blank"} 💎 | ✔️ | ✔️ | | ✔️ |
|
||||
| | [Analyze PR Components](/tools/Analyze/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Add PR Documentation](./tools/documentation.md){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Generate Custom Labels](./tools/describe.md#handle-custom-labels-from-the-repos-labels-page-💎){:target="_blank"} 💎 | ✔️ | ✔️ | | ✔️ |
|
||||
| | [Analyze PR Components](./tools/analyze.md){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | | | | | ️ |
|
||||
| USAGE | CLI | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | App / webhook | ✔️ | ✔️ | | ✔️ |
|
||||
@ -40,8 +40,8 @@ PR-Agent offers extensive pull request functionalities across various git provid
|
||||
| | Adaptive and token-aware file patch fitting | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Multiple models support | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | Incremental PR review | ✔️ | | | |
|
||||
| | [Static code analysis](/tools/analyze/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Multiple configuration options](usage-guide/configuration_options/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
| | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎 | ✔️ | ✔️ | ✔️ | ✔️ |
|
||||
|
||||
💎 marks a feature available only in [PR-Agent Pro](https://www.codium.ai/pricing/){:target="_blank"}
|
||||
|
||||
@ -131,7 +131,7 @@ The following diagram illustrates PR-Agent tools and their flow:
|
||||
|
||||
|
||||
|
||||
Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more details on how we convert a code diff to a manageable LLM prompt
|
||||
Check out the [PR Compression strategy](core-abilities/index.md) page for more details on how we convert a code diff to a manageable LLM prompt
|
||||
|
||||
|
||||
|
||||
@ -143,14 +143,14 @@ Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more detai
|
||||
2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
|
||||
3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
|
||||
4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional tools and features:
|
||||
- [**Analyze PR components**](/tools/analyze/)
|
||||
- [**Custom Code Suggestions**](/tools/custom_suggestions/)
|
||||
- [**Tests**](/tools/test/)
|
||||
- [**PR documentation**](/tools/documentation/)
|
||||
- [**CI feedback**](./tools/ci_feedback/)
|
||||
- [**SOC2 compliance check**](/tools/review/#soc2-ticket-compliance)
|
||||
- [**Custom labels**](/tools/describe/#handle-custom-labels-from-the-repos-labels-page)
|
||||
- [**Global and wiki configuration**](/usage-guide/configuration_options/#wiki-configuration-file)
|
||||
- [**Analyze PR components**](./tools/analyze.md/)
|
||||
- [**Custom Code Suggestions**](./tools/custom_suggestions.md/)
|
||||
- [**Tests**](./tools/test.md/)
|
||||
- [**PR documentation**](./tools/documentation.md/)
|
||||
- [**CI feedback**](./tools/ci_feedback.md/)
|
||||
- [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance)
|
||||
- [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page)
|
||||
- [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file)
|
||||
|
||||
|
||||
|
||||
@ -161,7 +161,7 @@ A reasonable question that can be asked is: `"Why use PR-Agent? What makes it st
|
||||
Here are some advantages of PR-Agent:
|
||||
|
||||
- PR-Agent emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We believe this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
|
||||
- PR-Agent [Compression strategy](./PR_COMPRESSION.md) is a core ability that enables to effectively tackle both short and long PRs.
|
||||
- PR-Agent [Compression strategy](core-abilities/index.md) is a core ability that enables to effectively tackle both short and long PRs.
|
||||
- YAML prompting strategy enables to have **modular, customizable, highly efficient tools**.
|
||||
- PR-Agent is flexible and **highly configurable**.
|
||||
- PR-Agent supports **multiple git providers** (GitHub, Gitlab, Bitbucket, Azure devops), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama, ...).
|
||||
@ -173,12 +173,4 @@ If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You
|
||||
https://openai.com/enterprise-privacy
|
||||
|
||||
When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
|
||||
You will also benefit from an OpenAI account with zero data retention.
|
||||
|
||||
## Links
|
||||
|
||||
- [Discord community](https://discord.gg/kG35uSHDBc)
|
||||
- [CodiumAI site](https://codium.ai)
|
||||
- [Blogs](https://www.codium.ai/blog/)
|
||||
- [Troubleshooting](https://www.codium.ai/blog/technical-faq-and-troubleshooting/)
|
||||
- [Support](support@codium.ai)
|
||||
You will also benefit from an OpenAI account with zero data retention.
|
||||
@ -58,7 +58,7 @@ The GITHUB_TOKEN secret is automatically created by GitHub.
|
||||
3. Merge this change to your main branch.
|
||||
When you open your next PR, you should see a comment from `github-actions` bot with a review of your PR, and instructions on how to use the rest of the tools.
|
||||
|
||||
4. You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](pr_agent/settings/configuration.toml) file. Some examples:
|
||||
4. You may configure PR-Agent by adding environment variables under the env section corresponding to any configurable property in the [configuration](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
|
||||
```yaml
|
||||
env:
|
||||
# ... previous environment values
|
||||
@ -122,7 +122,7 @@ git clone https://github.com/Codium-ai/pr-agent.git
|
||||
- Copy your app's private key to the private_key field.
|
||||
- Copy your app's ID to the app_id field.
|
||||
- Copy your app's webhook secret to the webhook_secret field.
|
||||
- Set deployment_type to 'app' in [configuration.toml](./pr_agent/settings/configuration.toml)
|
||||
- Set deployment_type to 'app' in [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)
|
||||
|
||||
> The .secrets.toml file is not copied to the Docker image by default, and is only used for local development.
|
||||
> If you want to use the .secrets.toml file in your Docker image, you can add remove it from the .dockerignore file.
|
||||
@ -164,7 +164,7 @@ docker push codiumai/pr-agent:github_app # Push to your Docker repository
|
||||
|
||||
> **Note:** When running PR-Agent from GitHub App, the default configuration file (configuration.toml) will be loaded.
|
||||
> However, you can override the default tool parameters by uploading a local configuration file `.pr_agent.toml`
|
||||
> For more information please check out the [USAGE GUIDE](./Usage.md#working-with-github-app)
|
||||
> For more information please check out the [USAGE GUIDE](../usage-guide/automations_and_usage.md#github-app)
|
||||
---
|
||||
|
||||
## Deploy as a Lambda Function
|
||||
|
||||
@ -10,7 +10,7 @@ WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
|
||||
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](./pr_agent/settings/configuration.toml)
|
||||
- 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.
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
If you choose to host you own PR-Agent, you first need to acquire two tokens:
|
||||
|
||||
1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](/usage-guide/additional_configurations/#changing-a-model), if you prefer).
|
||||
1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4 (or a key for [other models](../usage-guide/additional_configurations.md/#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)]
|
||||
|
||||
There are several ways to use self-hosted PR-Agent:
|
||||
|
||||
@ -11,7 +11,7 @@ Here is a list of PR-Agent tools, each with a dedicated page that explains how t
|
||||
| **[Update Changelog (`/update_changelog`](./update_changelog.md))** | Automatically updating the CHANGELOG.md file with the PR changes |
|
||||
| **[Find Similar Issue (`/similar_issue`](./similar_issues.md))** | Automatically retrieves and presents similar issues |
|
||||
| **💎 [Add Documentation (`/add_docs`](./documentation.md))** | Generates documentation to methods/functions/classes that changed in the PR |
|
||||
| **💎 [Generate Custom Labels (`/generate_labels`](./docs/custom_labels.md))** | Generates custom labels for the PR, based on specific guidelines defined by the user |
|
||||
| **💎 [Generate Custom Labels (`/generate_labels`](./custom_labels.md))** | Generates custom labels for the PR, based on specific guidelines defined by the user |
|
||||
| **💎 [Analyze (`/analyze`](./analyze.md))** | Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component |
|
||||
| **💎 [Custom Suggestions (`/custom_suggestions`](./custom_suggestions.md))** | Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user |
|
||||
| **💎 [Generate Tests (`/test component_name`](./test.md))** | Automatically generates unit tests for a selected component, based on the PR code changes |
|
||||
|
||||
@ -27,7 +27,7 @@ All PR-Agent tools have a parameter called `extra_instructions`, that enables to
|
||||
|
||||
The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
|
||||
This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
|
||||
When the PR is above the token limit, it employs a [PR Compression strategy]([./PR_COMPRESSION.md](https://github.com/Codium-ai/pr-agent/blob/main/PR_COMPRESSION.md)).
|
||||
When the PR is above the token limit, it employs a [PR Compression strategy](../core-abilities/index.md).
|
||||
|
||||
However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
|
||||
1) [Use a model](https://codium-ai.github.io/Docs-PR-Agent/usage-guide/#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
|
||||
|
||||
@ -8,7 +8,7 @@ nav:
|
||||
- GitHub: 'installation/github.md'
|
||||
- GitLab: 'installation/gitlab.md'
|
||||
- BitBucket: 'installation/bitbucket.md'
|
||||
- Azure DevOps: 'installation/azure_devops.md'
|
||||
- Azure DevOps: 'installation/azure.md'
|
||||
- Usage Guide:
|
||||
- 'usage-guide/index.md'
|
||||
- Introduction: 'usage-guide/introduction.md'
|
||||
|
||||
Reference in New Issue
Block a user