Update Installation Instructions and Running PR-Agent from Source Guide #590

EduardDurech · 2024-01-13T05:32:26Z

User description

Previously only installed dependencies but not pr_agent

Fixed link to OpenAI API Key and added for GitHub access token

Type

Documentation

Description

This PR primarily focuses on improving the documentation for installing and running the PR-Agent from source. The key changes include:

The link to the OpenAI API Key in the installation instructions has been updated, and a link for obtaining a GitHub access token has been added.
The instructions for running the PR-Agent from source have been modified. Users are now instructed to navigate to the /pr-agent folder before installing the requirements. A note has also been added about handling a potential Rust-related error during dependency installation.
The requirement to add the pr_agent folder to the PYTHONPATH before running the cli.py script has been removed from the main instructions and is now listed as an optional step.

Changes walkthrough

Relevant files

Documentation

INSTALL.md INSTALL.md The changes in the file INSTALL.md include: Updated the link to the OpenAI API Key and added a link for obtaining a GitHub access token. Modified the instructions for running the PR-Agent from source. The new instructions include navigating to the `/pr-agent` folder before installing the requirements, and a note about handling a potential Rust-related error during dependency installation. Removed the step of adding the pr_agent folder to the PYTHONPATH before running the cli.py script. This step is now optional and moved to the end of the instructions.	+12/-6

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: `pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...]` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: `pr_commands = ["/describe --pr_description.use_description_markers=true", ...]` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: `type`: the PR type. `summary`: the PR summary. `walkthrough`: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: `Main topic:performance` - pr_agent:The main topic of this PR is performance `New endpoint` - pr_agent:A new endpoint was added in this PR `SQL query` - pr_agent:A new SQL query was added in this PR `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Utilizing extra instructions The `describe` tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: `[pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

Previously only installed dependencies but not pr_agent + Fixed link to OpenAI API Key and added for GitHub access token

codiumai-pr-agent-pro · 2024-01-13T05:32:44Z

PR Description updated to latest commit (7a3830d)

codiumai-pr-agent-pro · 2024-01-13T05:32:56Z

PR Analysis

🎯 Main theme: Updating the installation instructions for the PR-Agent
📝 PR summary: This PR updates the instructions for running the PR-Agent from source. It includes changes to the links for acquiring the OpenAI key and GitHub access token, changes to the installation command, and additional tips for the user.
📌 Type of PR: Documentation
🧪 Relevant tests added: No
⏱️ Estimated effort to review [1-5]: 1, because the PR is small and straightforward, focusing on documentation changes only.
🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The changes made in this PR are clear and improve the user experience when installing the PR-Agent. The instructions are more detailed and the links are updated. Good job on making these improvements.

🤖 Code feedback:

relevant file	INSTALL.md
suggestion	Consider adding a note about the importance of keeping the OpenAI key and GitHub access token secure to prevent unauthorized access. [important]
relevant line	1. An OpenAI key from [here

✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: `[pr_reviewer] # /review # extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation When you first install PR-Agent app, the default mode for the `review` tool is: `pr_commands = ["/review", ...]` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations
About the 'Code feedback' section The `review` tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the `improve` feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well.
Auto-labels The `review` tool can auto-generate two specific types of labels for a PR: a `possible security issue` label, that detects possible security issues (`enable_review_labels_security` flag) a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Extra sub-tools The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_review`, `enable_review_labels_effort`, and more.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

mrT23 · 2024-01-13T19:18:26Z

INSTALL.md

 ```
-pip install -r requirements.txt
+pip install -e .


can you explain this line ? why do we need this change ?

The original wouldn't install pr_agent as a pip package and thus couldn't be called by python3, one could call python3 -m cli.py ... but wouldn't have ability to call pr_agent[.cli] First ran into it by following the installation guide and it could not find pr_agent

The -e is not necessary, but it makes it possible to edit the source files without having to re-install the pip package every time

I need to add requirements.txt to setup.py though, will do that in a few minutes

Just tested on a clean environment, pip install . will install the dependencies automatically, so no need to edit setup.py, but the -e flag is optional

what was wrong with the old line ?

mrT23 · 2024-01-13T19:18:44Z

INSTALL.md


+*Tip: make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs*


why do we need rust ?

CLI gave me an error while building the requirements.txt, it seems to be a dependency on one of the dependencies, if you want I can find which package it was exactly but will need to uninstall Rust and start a new env

After a clean environment it seems to not need it, I don't know what package was causing the error before but I found a few resources online of people mentioning random fixes so I think it may be something external, I will edit it just as a tip if they have the same error

mrT23 · 2024-01-18T14:37:11Z

PR Description updated to latest commit (a58c385)

Fixed Run from source instructions for Python

Fixed Run from source instructions for Python

7a3830d

Previously only installed dependencies but not pr_agent + Fixed link to OpenAI API Key and added for GitHub access token

codiumai-pr-agent-pro bot added the Review effort [1-5]: 1 label Jan 13, 2024

mrT23 reviewed Jan 13, 2024

View reviewed changes

Fixed Rust warning tip as behaviour is inconsistent

a58c385

mrT23 approved these changes Jan 17, 2024

View reviewed changes

mrT23 merged commit fae3bf6 into Codium-ai:main Jan 17, 2024

mrT23 changed the title ~~Fixed Run from source instructions for Python~~ Update Installation Instructions and Running PR-Agent from Source Guide Jan 18, 2024

mrT23 added the documentation Improvements or additions to documentation label Jan 18, 2024

yochail pushed a commit to yochail/pr-agent that referenced this pull request Feb 11, 2024

Merge pull request Codium-ai#590 from EduardDurech/patch-2

5d5d336

Fixed Run from source instructions for Python

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Installation Instructions and Running PR-Agent from Source Guide #590

Update Installation Instructions and Running PR-Agent from Source Guide #590

EduardDurech commented Jan 13, 2024 •

edited by mrT23

Loading

codiumai-pr-agent-pro bot commented Jan 13, 2024

codiumai-pr-agent-pro bot commented Jan 13, 2024

mrT23 Jan 13, 2024 •

edited

Loading

EduardDurech Jan 13, 2024

EduardDurech Jan 14, 2024

mrT23 Jan 14, 2024

mrT23 Jan 13, 2024

EduardDurech Jan 13, 2024

EduardDurech Jan 14, 2024

mrT23 commented Jan 18, 2024


		Tip: make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs

Update Installation Instructions and Running PR-Agent from Source Guide #590

Update Installation Instructions and Running PR-Agent from Source Guide #590

Conversation

EduardDurech commented Jan 13, 2024 • edited by mrT23 Loading

User description

Type

Description

Changes walkthrough

codiumai-pr-agent-pro bot commented Jan 13, 2024

codiumai-pr-agent-pro bot commented Jan 13, 2024

PR Analysis

PR Feedback

mrT23 Jan 13, 2024 • edited Loading

Choose a reason for hiding this comment

EduardDurech Jan 13, 2024

Choose a reason for hiding this comment

EduardDurech Jan 14, 2024

Choose a reason for hiding this comment

mrT23 Jan 14, 2024

Choose a reason for hiding this comment

mrT23 Jan 13, 2024

Choose a reason for hiding this comment

EduardDurech Jan 13, 2024

Choose a reason for hiding this comment

EduardDurech Jan 14, 2024

Choose a reason for hiding this comment

mrT23 commented Jan 18, 2024

EduardDurech commented Jan 13, 2024 •

edited by mrT23

Loading

mrT23 Jan 13, 2024 •

edited

Loading