Skip to content

Commit 19237a5

Browse files
authored
Merge pull request #2328 from The-PR-Agent/of/update-repo-references-in-docs
docs: update GitHub org references from qodo-ai to the-pr-agent
2 parents d82f7d3 + 53c9ddb commit 19237a5

20 files changed

Lines changed: 56 additions & 56 deletions

docs/docs/core-abilities/metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ By default, the first command that PR-Agent executes is [`describe`](../tools/de
2424
These AI-generated outputs are now considered as part of the PR metadata, and can be used in subsequent commands like `review` and `improve`.
2525
This effectively enables multi-stage chain-of-thought analysis, without doing any additional API calls which will cost time and money.
2626

27-
For example, when generating code suggestions for different files, PR-Agent can inject the AI-generated ["Changes walkthrough"](https://github.com/qodo-ai/pr-agent/pull/1202#issue-2511546839) file summary in the prompt:
27+
For example, when generating code suggestions for different files, PR-Agent can inject the AI-generated ["Changes walkthrough"](https://github.com/the-pr-agent/pr-agent/pull/1202#issue-2511546839) file summary in the prompt:
2828

2929
```diff
3030
## File: 'src/file1.py'

docs/docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
[PR-Agent](https://github.com/qodo-ai/pr-agent) is an open-source, AI-powered code review agent and a community-maintained legacy project of Qodo. It is distinct from Qodo's primary AI code review offering, which provides a feature-rich, context-aware experience. Qodo now offers a free tier that integrates seamlessly with GitHub, GitLab, Bitbucket, and Azure DevOps for high-quality automated reviews.
3+
[PR-Agent](https://github.com/the-pr-agent/pr-agent) is an open-source, AI-powered code review agent and a community-maintained legacy project of Qodo. It is distinct from Qodo's primary AI code review offering, which provides a feature-rich, context-aware experience. Qodo now offers a free tier that integrates seamlessly with GitHub, GitLab, Bitbucket, and Azure DevOps for high-quality automated reviews.
44

55
- See the [Installation Guide](./installation/index.md) for instructions on installing and running the tool on different git platforms.
66

@@ -14,7 +14,7 @@ To search the documentation site using natural language:
1414

1515
1) Comment `/help "your question"` in a pull request where PR-Agent is installed
1616

17-
2) The bot will respond with an [answer](https://github.com/qodo-ai/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
17+
2) The bot will respond with an [answer](https://github.com/the-pr-agent/pr-agent/pull/1241#issuecomment-2365259334) that includes relevant documentation links.
1818

1919
## Features
2020

@@ -36,7 +36,7 @@ PR-Agent offers comprehensive pull request functionalities integrated with vario
3636
| | | | | | | |
3737
| [USAGE](./usage-guide/index.md) | [CLI](./usage-guide/automations_and_usage.md#local-repo-cli) ||||||
3838
| | [App / webhook](./usage-guide/automations_and_usage.md#github-app) ||||||
39-
| | [Tagging bot](https://github.com/qodo-ai/pr-agent#try-it-now) || | | | |
39+
| | [Tagging bot](https://github.com/the-pr-agent/pr-agent#try-it-now) || | | | |
4040
| | [Actions](./installation/github.md#run-as-a-github-action) ||||| |
4141
| | | | | | | |
4242
| [CORE](./core-abilities/index.md) | [Adaptive and token-aware file patch fitting](./core-abilities/compression_strategy.md) ||||| |
@@ -53,21 +53,21 @@ PR-Agent offers comprehensive pull request functionalities integrated with vario
5353

5454
<hr>
5555

56-
#### [/describe](https://github.com/qodo-ai/pr-agent/pull/530)
56+
#### [/describe](https://github.com/the-pr-agent/pr-agent/pull/530)
5757

5858
<figure markdown="1">
5959
![/describe](https://www.codium.ai/images/pr_agent/describe_new_short_main.png){width=512}
6060
</figure>
6161
<hr>
6262

63-
#### [/review](https://github.com/qodo-ai/pr-agent/pull/732#issuecomment-1975099151)
63+
#### [/review](https://github.com/the-pr-agent/pr-agent/pull/732#issuecomment-1975099151)
6464

6565
<figure markdown="1">
6666
![/review](https://www.codium.ai/images/pr_agent/review_new_short_main.png){width=512}
6767
</figure>
6868
<hr>
6969

70-
#### [/improve](https://github.com/qodo-ai/pr-agent/pull/732#issuecomment-1975099159)
70+
#### [/improve](https://github.com/the-pr-agent/pr-agent/pull/732#issuecomment-1975099159)
7171

7272
<figure markdown="1">
7373
![/improve](https://www.codium.ai/images/pr_agent/improve_new_short_main.png){width=512}

docs/docs/installation/azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Note that you need to export the `azure_devops__pat` and `OPENAI_KEY` variables
6363

6464
Make sure to give pipeline permissions to the `pr_agent` variable group.
6565

66-
> Note that Azure Pipelines lacks support for triggering workflows from PR comments. If you find a viable solution, please contribute it to our [issue tracker](https://github.com/qodo-ai/pr-agent/issues)
66+
> Note that Azure Pipelines lacks support for triggering workflows from PR comments. If you find a viable solution, please contribute it to our [issue tracker](https://github.com/the-pr-agent/pr-agent/issues)
6767

6868
### Azure Repos Git PR triggers and Build Validation
6969

docs/docs/installation/gitea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
1313
4. Clone this repository:
1414

1515
```bash
16-
git clone https://github.com/qodo-ai/pr-agent.git
16+
git clone https://github.com/the-pr-agent/pr-agent.git
1717
```
1818

1919
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:

docs/docs/installation/github.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
steps:
2424
- name: PR Agent action step
2525
id: pragent
26-
uses: qodo-ai/pr-agent@main
26+
uses: the-pr-agent/pr-agent@main
2727
env:
2828
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
2929
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -41,7 +41,7 @@ The GITHUB_TOKEN secret is automatically created by GitHub.
4141
3) Merge this change to your main branch.
4242
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.
4343
44-
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/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
44+
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/the-pr-agent/pr-agent/blob/main/pr_agent/settings/configuration.toml) file. Some examples:
4545
4646
```yaml
4747
env:
@@ -79,7 +79,7 @@ jobs:
7979
contents: write
8080
steps:
8181
- name: PR Agent action step
82-
uses: qodo-ai/pr-agent@main
82+
uses: the-pr-agent/pr-agent@main
8383
env:
8484
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
8585
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -105,7 +105,7 @@ jobs:
105105
contents: write
106106
steps:
107107
- name: PR Agent action step
108-
uses: qodo-ai/pr-agent@main
108+
uses: the-pr-agent/pr-agent@main
109109
env:
110110
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
111111
config.model: "gemini/gemini-1.5-flash"
@@ -136,7 +136,7 @@ jobs:
136136
contents: write
137137
steps:
138138
- name: PR Agent action step
139-
uses: qodo-ai/pr-agent@main
139+
uses: the-pr-agent/pr-agent@main
140140
env:
141141
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
142142
config.model: "anthropic/claude-3-opus-20240229"
@@ -168,7 +168,7 @@ jobs:
168168
steps:
169169
- name: PR Agent action step
170170
id: pragent
171-
uses: qodo-ai/pr-agent@main
171+
uses: the-pr-agent/pr-agent@main
172172
env:
173173
OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
174174
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -370,7 +370,7 @@ jobs:
370370
steps:
371371
- name: PR Agent action step
372372
id: pragent
373-
uses: qodo-ai/pr-agent@main
373+
uses: the-pr-agent/pr-agent@main
374374
env:
375375
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
376376
GOOGLE_AI_STUDIO.GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
@@ -551,7 +551,7 @@ WEBHOOK_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
551551
4) Clone this repository:
552552

553553
```bash
554-
git clone https://github.com/qodo-ai/pr-agent.git
554+
git clone https://github.com/the-pr-agent/pr-agent.git
555555
```
556556

557557
5) Copy the secrets template file and fill in the following:
@@ -565,7 +565,7 @@ cp pr_agent/settings/.secrets_template.toml pr_agent/settings/.secrets.toml
565565
- Copy your app's private key to the private_key field.
566566
- Copy your app's ID to the app_id field.
567567
- Copy your app's webhook secret to the webhook_secret field.
568-
- Set deployment_type to 'app' in [configuration.toml](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)
568+
- Set deployment_type to 'app' in [configuration.toml](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/configuration.toml)
569569

570570
> The .secrets.toml file is not copied to the Docker image by default, and is only used for local development.
571571
> If you want to use the .secrets.toml file in your Docker image, you can add remove it from the .dockerignore file.
@@ -636,7 +636,7 @@ For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET`
636636

637637
4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
638638
5. Configure the lambda function to have a Function URL.
639-
6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/qodo-ai/pr-agent/pull/450#issuecomment-1840242269))
639+
6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/the-pr-agent/pr-agent/pull/450#issuecomment-1840242269))
640640
7. Go back to steps 8-9 of [Method 5](#run-as-a-github-app) with the function url as your Webhook URL.
641641
The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/api/v1/github_webhooks`
642642

docs/docs/installation/gitlab.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ SHARED_SECRET=$(python -c "import secrets; print(secrets.token_hex(10))")
6060
4. Clone this repository:
6161

6262
```bash
63-
git clone https://github.com/qodo-ai/pr-agent.git
63+
git clone https://github.com/the-pr-agent/pr-agent.git
6464
```
6565

6666
5. Prepare variables and secrets. Skip this step if you plan on setting these as environment variables when running the agent:
@@ -116,7 +116,7 @@ For example: `GITLAB.PERSONAL_ACCESS_TOKEN` --> `GITLAB__PERSONAL_ACCESS_TOKEN`
116116

117117
4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m.
118118
5. Configure the lambda function to have a Function URL.
119-
6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/qodo-ai/pr-agent/pull/450#issuecomment-1840242269))
119+
6. In the environment variables of the Lambda function, specify `AZURE_DEVOPS_CACHE_DIR` to a writable location such as /tmp. (see [link](https://github.com/the-pr-agent/pr-agent/pull/450#issuecomment-1840242269))
120120
7. Go back to steps 8-9 of [Run a GitLab webhook server](#run-a-gitlab-webhook-server) with the function URL as your Webhook URL.
121121
The Webhook URL would look like `https://<LAMBDA_FUNCTION_URL>/webhook`
122122

docs/docs/installation/locally.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To invoke a tool (for example `review`), you can run PR-Agent directly from the
5353
```
5454

5555

56-
For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values.
56+
For other git providers, update `CONFIG.GIT_PROVIDER` accordingly and check the [`pr_agent/settings/.secrets_template.toml`](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/.secrets_template.toml) file for environment variables expected names and values.
5757

5858
### Utilizing environment variables
5959

@@ -111,7 +111,7 @@ def main():
111111
provider = "github" # github/gitlab/bitbucket/azure_devops
112112
user_token = "..." # user token
113113
openai_key = "..." # OpenAI key
114-
pr_url = "..." # PR URL, for example 'https://github.com/qodo-ai/pr-agent/pull/809'
114+
pr_url = "..." # PR URL, for example 'https://github.com/the-pr-agent/pr-agent/pull/809'
115115
command = "/review" # Command to run (e.g. '/review', '/describe', '/ask="What is the purpose of this PR?"', ...)
116116
117117
# Setting the configurations
@@ -132,7 +132,7 @@ if __name__ == '__main__':
132132
1. Clone this repository:
133133

134134
```bash
135-
git clone https://github.com/qodo-ai/pr-agent.git
135+
git clone https://github.com/the-pr-agent/pr-agent.git
136136
```
137137

138138
2. Navigate to the `/pr-agent` folder and install the requirements in your favorite virtual environment:

docs/docs/tools/describe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ This option is enabled by default via the `pr_description.enable_pr_diagram` par
118118
</tr>
119119
<tr>
120120
<td><b>final_update_message</b></td>
121-
<td>If set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/qodo-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true.</td>
121+
<td>If set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/the-pr-agent/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true.</td>
122122
</tr>
123123
<tr>
124124
<td><b>enable_semantic_files_types</b></td>

docs/docs/tools/generate_labels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ enable_custom_labels = true
3333

3434
### Defining custom labels
3535

36-
You can define your own custom labels in the `[custom_labels]` section. See the [custom_labels.toml](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/custom_labels.toml) file for examples.
36+
You can define your own custom labels in the `[custom_labels]` section. See the [custom_labels.toml](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/custom_labels.toml) file for examples.
3737

3838
Example configuration:
3939

docs/docs/tools/help_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ When a new issue is opened, you should see a comment from `github-actions` bot w
100100

101101
## Configuration options
102102

103-
Under the section `pr_help_docs`, the [configuration file](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L199) contains options to customize the 'help docs' tool:
103+
Under the section `pr_help_docs`, the [configuration file](https://github.com/the-pr-agent/pr-agent/blob/main/pr_agent/settings/configuration.toml#L199) contains options to customize the 'help docs' tool:
104104

105105
- `repo_url`: If not overwritten, will use the repo from where the context came from (issue or PR), otherwise - use the given repo as context.
106106
- `repo_default_branch`: The branch to use in case repo_url overwritten, otherwise - has no effect.

0 commit comments

Comments
 (0)