diff --git a/README.md b/README.md index dddcbd565..86903c254 100644 --- a/README.md +++ b/README.md @@ -73,40 +73,40 @@ New option now available (💎) - **apply suggestions**: Supported commands per platform: -| | | GitHub | Gitlab | Bitbucket | Azure DevOps | -|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:| -| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Incremental | ✅ | | | | -| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | ✅ | -| | Describe | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | | -| | Improve | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | -| | Ask | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | -| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | ✅ | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | ✅ | -| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | -| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ | -| | Find Similar Issue | ✅ | | | | -| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | ✅ | -| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | ✅ | -| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | ✅ | -| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | -| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | -| | | | | | | -| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | -| | App / webhook | ✅ | ✅ | ✅ | ✅ | -| | Tagging bot | ✅ | | | | -| | Actions | ✅ | | ✅ | | -| | | | | | | -| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | -| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | -| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | -| | Multiple models support | ✅ | ✅ | ✅ | ✅ | -| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | ✅ | -| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | ✅ | -| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | | | | +| | | GitHub | Gitlab | Bitbucket | Azure DevOps | +|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:------------:| +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Incremental | ✅ | | | | +| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | | +| | Improve | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | +| | [Custom Prompt](https://pr-agent-docs.codium.ai/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | | +| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | | +| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ | +| | Find Similar Issue | ✅ | | | | +| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | | +| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | | +| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | | +| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | +| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | +| | | | | | | +| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | +| | App / webhook | ✅ | ✅ | ✅ | ✅ | +| | Tagging bot | ✅ | | | | +| | Actions | ✅ | | ✅ | | +| | | | | | | +| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | +| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | +| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | +| | Multiple models support | ✅ | ✅ | ✅ | ✅ | +| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | | +| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | | +| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | ✅ | | | - 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) @@ -225,7 +225,12 @@ For example, add a comment to any pull request with the following text: ``` @CodiumAI-Agent /review ``` -and the agent will respond with a review of your PR +and the agent will respond with a review of your PR. + +Note that this is a promotional bot, suitable only for initial experimentation. +It does not have `edit` access to you repo, for example, so it cannot update the PR description or add labels. +Comment: `@CodiumAI-Agent /describe --pr_description.publish_description_as_comment=true` to publish the description as a comment in the PR. +`@CodiumAI-Agent /review` and `@CodiumAI-Agent /improve` should work as-is. ![Review generation process](https://www.codium.ai/images/demo-2.gif) @@ -235,43 +240,6 @@ Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there --- -[//]: # (## Installation) - -[//]: # (To use your own version of PR-Agent, you first need to acquire two tokens:) - -[//]: # () -[//]: # (1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.) - -[//]: # (2. A GitHub personal access token (classic) with the repo scope.) - -[//]: # () -[//]: # (There are several ways to use PR-Agent:) - -[//]: # () -[//]: # (**Locally**) - -[//]: # (- [Using pip package](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package)) - -[//]: # (- [Using Docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image)) - -[//]: # (- [Run from source](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source)) - -[//]: # () -[//]: # (**GitHub specific methods**) - -[//]: # (- [Run as a GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action)) - -[//]: # (- [Run as a GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app)) - -[//]: # () -[//]: # (**GitLab specific methods**) - -[//]: # (- [Run a GitLab webhook server](https://pr-agent-docs.codium.ai/installation/gitlab/)) - -[//]: # () -[//]: # (**BitBucket specific methods**) - -[//]: # (- [Run as a Bitbucket Pipeline](https://pr-agent-docs.codium.ai/installation/bitbucket/)) ## PR-Agent Pro 💎 [PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits: diff --git a/docs/docs/css/custom.css b/docs/docs/css/custom.css index 9df64644d..356283186 100644 --- a/docs/docs/css/custom.css +++ b/docs/docs/css/custom.css @@ -11,6 +11,19 @@ } } +.md-nav--primary { + position: relative; /* Ensure the element is positioned */ +} + +.md-nav--primary::before { + content: ""; + position: absolute; + top: 0; + right: 10px; /* Move the border 10 pixels to the right */ + width: 2px; + height: 100%; + background-color: #f5f5f5; /* Match the border color */ +} /*.md-nav__title, .md-nav__link {*/ /* font-size: 18px;*/ /* margin-top: 14px; !* Adjust the space as needed *!*/ diff --git a/docs/docs/index.md b/docs/docs/index.md index 26705e377..6e2ebd888 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -14,33 +14,33 @@ PR-Agent offers extensive pull request functionalities across various git provid | | | GitHub | Gitlab | Bitbucket | Azure DevOps | |-------|-----------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|:------------:| -| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | | | ⮑ Incremental | ✅ | | | | -| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | Ask | ✅ | ✅ | ✅ | ✅ | -| | Describe | ✅ | ✅ | ✅ | ✅ | -| | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | ✅ | -| | Improve | ✅ | ✅ | ✅ | ✅ | -| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | -| | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance){:target="_blank"} 💎 | ✅ | ✅ | ✅ | | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline file summary](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary){:target="_blank"} 💎 | ✅ | ✅ | | | +| | Improve | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | +| | [Custom Prompt](./tools/custom_prompt.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | | +| | Reflect and Review | ✅ | ✅ | ✅ | | | | Update CHANGELOG.md | ✅ | ✅ | ✅ | ️ | | | Find Similar Issue | ✅ | | | ️ | -| | [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"} 💎 | ✅ | ✅ | | ✅ | +| | [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 | ✅ | ✅ | ✅ | ✅ | +| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | +| | App / webhook | ✅ | ✅ | ✅ | ✅ | | | Actions | ✅ | | | ️ | | | | | | | -| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | -| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | -| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | -| | Multiple models support | ✅ | ✅ | ✅ | ✅ | -| | Incremental PR review | ✅ | | | | -| | [Static code analysis](./tools/analyze.md/){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | -| | [Multiple configuration options](./usage-guide/configuration_options.md){:target="_blank"} 💎 | ✅ | ✅ | ✅ | ✅ | +| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | +| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | +| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | +| | Multiple models support | ✅ | ✅ | ✅ | ✅ | +| | Incremental PR review | ✅ | | | | +| | [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"} diff --git a/docs/docs/installation/bitbucket.md b/docs/docs/installation/bitbucket.md index d3c93ad90..9023399bb 100644 --- a/docs/docs/installation/bitbucket.md +++ b/docs/docs/installation/bitbucket.md @@ -27,9 +27,9 @@ 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 +## Run using CodiumAI-hosted Bitbucket app 💎 -Please contact [support@codium.ai](mailto:support@codium.ai) or visit [CodiumAI pricing page](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. +Please contact visit [PR-Agent pro](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 f8b64a270..c82e6bd0e 100644 --- a/docs/docs/installation/index.md +++ b/docs/docs/installation/index.md @@ -15,8 +15,7 @@ There are several ways to use self-hosted PR-Agent: - [Azure DevOps](./azure.md) ## PR-Agent Pro 💎 -PR-Agent Pro, an app for GitHub\GitLab\BitBucket hosted by CodiumAI, is also available. -
-With PR-Agent Pro Installation is as simple as signing up and adding the PR-Agent app to your relevant repo. +PR-Agent Pro, an app hosted by CodiumAI for GitHub\GitLab\BitBucket, is also available.
+With PR-Agent Pro, installation is as simple as signing up and adding the PR-Agent app to your relevant repo. See [here](./pr_agent_pro.md) for more details. \ No newline at end of file diff --git a/docs/docs/usage-guide/PR_agent_pro_models.md b/docs/docs/usage-guide/PR_agent_pro_models.md new file mode 100644 index 000000000..6f4f412ed --- /dev/null +++ b/docs/docs/usage-guide/PR_agent_pro_models.md @@ -0,0 +1,21 @@ +## PR-Agent Pro Models + +The default models used by PR-Agent Pro are OpenAI's GPT-4 models. We use a combination of GPT-4-Turbo and GPT-4o to strike a balance between speed and quality. + +However, users can change the model used by PR-Agent Pro to Claude-3.5-sonnet, which also excels in code tasks. +To do so, add the following to your [configuration](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) file: + +``` +[config] +model="claude-3-5-sonnet" +``` + +You can also use different models for different tools. For example, you can use the Claude-3.5-sonnet model only for the `improve` tool (and keep the default GPT-4 model for the other tools) by adding the following to your configuration file: +``` +[github_app] +pr_commands = [ + "/describe --pr_description.final_update_message=false", + "/review --pr_reviewer.num_code_suggestions=0", + "/improve --config.model=claude-3-5-sonnet", +] +``` \ No newline at end of file diff --git a/docs/docs/usage-guide/automations_and_usage.md b/docs/docs/usage-guide/automations_and_usage.md index 96545e1a2..3bd5fce04 100644 --- a/docs/docs/usage-guide/automations_and_usage.md +++ b/docs/docs/usage-guide/automations_and_usage.md @@ -26,6 +26,16 @@ verbosity_level=2 ``` This is useful for debugging or experimenting with different tools. +(3) + +**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in a configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: +` +"github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit" +` + +Default is "github". + + ### Online usage diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index 37191914c..d0cf0bae2 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -18,9 +18,12 @@ In terms of precedence, wiki configurations will override local configurations, ## Wiki configuration file 💎 -For GitHub and GitLab, with PR-Agent-Pro you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. +`Platforms supported: GitHub, GitLab` + +With PR-Agent-Pro, you can set configurations by creating a page called `.pr_agent.toml` in the [wiki](https://github.com/Codium-ai/pr-agent/wiki/pr_agent.toml) of the repo. The advantage of this method is that it allows to set configurations without needing to commit new content to the repo - just edit the wiki page and **save**. + ![wiki_configuration](https://codium.ai/images/pr_agent/wiki_configuration.png){width=512} Click [here](https://codium.ai/images/pr_agent/wiki_configuration_pr_agent.mp4) to see a short instructional video. We recommend surrounding the configuration content with triple-quotes, to allow better presentation when displayed in the wiki as markdown. @@ -35,6 +38,9 @@ PR-Agent will know to remove the triple-quotes when reading the configuration co ## Local configuration file +`Platforms supported: GitHub, GitLab, Bitbucket, Azure DevOps` + + By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect. For example, if you set in `.pr_agent.toml`: @@ -53,6 +59,8 @@ Then you can give a list of extra instructions to the `review` tool. ## Global configuration file 💎 +`Platforms supported: GitHub, GitLab, Bitbucket` + If you create a repo called `pr-agent-settings` in your **organization**, it's configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization. Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters. @@ -60,4 +68,4 @@ For example, in the GitHub organization `Codium-ai`: - The file [`https://github.com/Codium-ai/pr-agent-settings/.pr_agent.toml`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml) serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`. -- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml), for example, inherits the global configuration file from `pr-agent-settings`. +- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`. diff --git a/docs/docs/usage-guide/index.md b/docs/docs/usage-guide/index.md index ce714c708..8304aded4 100644 --- a/docs/docs/usage-guide/index.md +++ b/docs/docs/usage-guide/index.md @@ -1,10 +1,11 @@ # Usage guide -This page provides a detailed guide on how to use PR-Agent. It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, manage mail notifications, and other advanced configurations. +This page provides a detailed guide on how to use PR-Agent. +It includes information on how to adjust PR-Agent configurations, define which tools will run automatically, and other advanced configurations. - [Introduction](./introduction.md) -- [Configuration Options](./configuration_options.md) +- [Configuration File](./configuration_options.md) - [Usage and Automation](./automations_and_usage.md) - [Local Repo (CLI)](./automations_and_usage.md#local-repo-cli) - [Online Usage](./automations_and_usage.md#online-usage) @@ -20,4 +21,5 @@ This page provides a detailed guide on how to use PR-Agent. It includes informat - [Working with large PRs](./additional_configurations.md#working-with-large-prs) - [Changing a model](./additional_configurations.md#changing-a-model) - [Patch Extra Lines](./additional_configurations.md#patch-extra-lines) - - [Editing the prompts](./additional_configurations.md#editing-the-prompts) \ No newline at end of file + - [Editing the prompts](./additional_configurations.md#editing-the-prompts) +- [PR-Agent Pro Models](./PR_agent_pro_models.md) \ No newline at end of file diff --git a/docs/docs/usage-guide/introduction.md b/docs/docs/usage-guide/introduction.md index 74f7a64fc..6fa6855d4 100644 --- a/docs/docs/usage-guide/introduction.md +++ b/docs/docs/usage-guide/introduction.md @@ -7,12 +7,7 @@ After [installation](https://pr-agent-docs.codium.ai/installation/), there are t Specifically, CLI commands can be issued by invoking a pre-built [docker image](https://pr-agent-docs.codium.ai/installation/locally/#using-docker-image), or by invoking a [locally cloned repo](https://pr-agent-docs.codium.ai/installation/locally/#run-from-source). -For online usage, you will need to setup either a [GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app), or a [GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action). -GitHub App and GitHub Action also enable to run PR-Agent specific tool automatically when a new PR is opened. - -**git provider**: The [git_provider](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L5) field in the configuration file determines the GIT provider that will be used by PR-Agent. Currently, the following providers are supported: -` -"github", "gitlab", "bitbucket", "azure", "codecommit", "local", "gerrit" -` +For online usage, you will need to setup either a [GitHub App](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-app) or a [GitHub Action](https://pr-agent-docs.codium.ai/installation/github/#run-as-a-github-action) (GitHub), a [GitLab webhook](https://pr-agent-docs.codium.ai/installation/gitlab/#run-a-gitlab-webhook-server) (GitLab), or a [BitBucket App](https://pr-agent-docs.codium.ai/installation/bitbucket/#run-using-codiumai-hosted-bitbucket-app) (BitBucket). +These platforms also enable to run PR-Agent specific tools automatically when a new PR is opened, or on each push to a branch. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index b40c4d104..cf34d800c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -18,9 +18,9 @@ nav: - Usage Guide: - 'usage-guide/index.md' - Introduction: 'usage-guide/introduction.md' - - Configuration Options: 'usage-guide/configuration_options.md' - - Managing Mail Notifications: 'usage-guide/mail_notifications.md' + - Configuration File: 'usage-guide/configuration_options.md' - Usage and Automation: 'usage-guide/automations_and_usage.md' + - Managing Mail Notifications: 'usage-guide/mail_notifications.md' - Additional Configurations: 'usage-guide/additional_configurations.md' - Tools: - 'tools/index.md'