diff --git a/INSTALL.md b/INSTALL.md index d06b744d..2deed774 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -14,7 +14,6 @@ There are several ways to use PR-Agent: **GitHub specific methods** - [Run as a GitHub Action](INSTALL.md#run-as-a-github-action) -- [Run as a polling server](INSTALL.md#run-as-a-polling-server) - [Run as a GitHub App](INSTALL.md#run-as-a-github-app) - [Deploy as a Lambda Function](INSTALL.md#deploy-as-a-lambda-function) - [AWS CodeCommit](INSTALL.md#aws-codecommit-setup) @@ -186,19 +185,6 @@ When you open your next PR, you should see a comment from `github-actions` bot w --- -### Run as a polling server -Request reviews by tagging your GitHub user on a PR - -Follow [steps 1-3](#run-as-a-github-action) of the GitHub Action setup. - -Run the following command to start the server: - -``` -python pr_agent/servers/github_polling.py -``` - ---- - ### Run as a GitHub App Allowing you to automate the review process on your private or public repositories. diff --git a/README.md b/README.md index 3c592dd1..642006e1 100644 --- a/README.md +++ b/README.md @@ -217,17 +217,19 @@ To use your own version of PR-Agent, you first need to acquire two tokens: There are several ways to use PR-Agent: -- [Method 1: Use Docker image (no installation required)](INSTALL.md#method-1-use-docker-image-no-installation-required) -- [Method 2: Run from source](INSTALL.md#method-2-run-from-source) -- [Method 3: Run as a GitHub Action](INSTALL.md#method-3-run-as-a-github-action) -- [Method 4: Run as a polling server](INSTALL.md#method-4-run-as-a-polling-server) - - Request reviews by tagging your GitHub user on a PR -- [Method 5: Run as a GitHub App](INSTALL.md#method-5-run-as-a-github-app) - - Allowing you to automate the review process on your private or public repositories -- [Method 6: Deploy as a Lambda Function](INSTALL.md#method-6---deploy-as-a-lambda-function) -- [Method 7: AWS CodeCommit](INSTALL.md#method-7---aws-codecommit-setup) -- [Method 8: Run a GitLab webhook server](INSTALL.md#method-8---run-a-gitlab-webhook-server) -- [Method 9: Run as a Bitbucket Pipeline](INSTALL.md#method-9-run-as-a-bitbucket-pipeline) +**Locally** +- [Use Docker image (no installation required)](./INSTALL.md#use-docker-image-no-installation-required) +- [Run from source](./INSTALL.md#run-from-source) + +**GitHub specific methods** +- [Run as a GitHub Action](./INSTALL.md#run-as-a-github-action) +- [Run as a GitHub App](./INSTALL.md#run-as-a-github-app) + +**GitLab specific methods** +- [Run a GitLab webhook server](./INSTALL.md#run-a-gitlab-webhook-server) + +**BitBucket specific methods** +- [Run as a Bitbucket Pipeline](./INSTALL.md#run-as-a-bitbucket-pipeline) ## 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: