chore: added pr-agent file

[saalim-mushtaq]

Type

enhancement

---

Description

• Added a new GitHub Actions workflow to enhance pull request and issue comment handling.
• The workflow runs on every pull request and issue comment, aiming to automate responses and actions.
• It uses Codium-ai/pr-agent@main for executing the PR agent, leveraging GitHub secrets for authentication.

---

Changes walkthrough

Relevant files

Enhancement

pr-agent.yml Introduce PR Agent GitHub Actions Workflow                              .github/workflows/pr-agent.yml Introduced a new GitHub Actions workflow for PR and issue comment handling. Configured the workflow to run on ubuntu-latest. Set permissions for issues, pull-requests, and contents to write. Utilizes Codium-ai/pr-agent@main to run the PR agent. Environment variables for OPENAI_KEY and GITHUB_TOKEN are configured. +18/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To use it, please link your git user with your CodiumAI identity here.

PR Description updated to latest commit (c68aab3)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR-Agent was enabled for this repository. To use it, please link your git user with your CodiumAI identity here.

PR Review

⏱️ Estimated effort to review [1-5]	2, because the PR introduces a new GitHub Actions workflow which is relatively straightforward to review. The workflow is not complex, and it mainly involves setting up permissions and environment variables for the PR agent to work correctly.
🧪 Relevant tests	No
🔍 Possible issues	YAML Syntax: The indentation for the 'pull_request' and 'issue_comment' triggers under 'on:' might be incorrect. YAML is highly sensitive to indentation, and this could potentially cause the workflow not to trigger as expected.
	Missing Newline: There is no newline at the end of the file. While this is not a functional issue, it's a common practice to include a newline at the end of files to comply with POSIX standards.
🔒 Security concerns	- Sensitive Information Exposure: The workflow uses secrets for 'OPENAI_KEY' and 'GITHUB_TOKEN'. It's crucial to ensure that these secrets are properly secured and have the minimum required scopes to reduce the risk of unauthorized access.

---

✨ Review tool 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 'possible issues' 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

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_ticket, require_can_be_split_review, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

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.

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Best practice	Pin the Codium-ai/pr-agent action to a specific version. It's recommended to specify the version of the action used (Codium-ai/pr-agent@main) to a specific release or commit. Using a specific version helps in ensuring that your workflow does not break if the action's main branch is updated with breaking changes. .github/workflows/pr-agent.yml [15] -uses: Codium-ai/pr-agent@main +uses: Codium-ai/[email protected] # Example version, replace with the latest version available
Enhancement	Add a step to check out the repository's code before running the PR Agent action. Consider adding a step for checking out the repository using actions/checkout@v2 before using the Codium-ai/pr-agent action. This is necessary if the action or any subsequent steps require access to the repository's code. .github/workflows/pr-agent.yml [13] +- uses: actions/checkout@v2 + name: Checkout code - name: PR Agent action step
	Specify event types for pull_request and issue_comment to trigger the workflow only for relevant activities. To ensure the workflow is only triggered for relevant activities, consider specifying types for the pull_request and issue_comment events. For example, you might only want to run this workflow for opened, reopened, and synchronize pull request events. .github/workflows/pr-agent.yml [2-3] pull_request: + types: [opened, reopened, synchronize] issue_comment: + types: [created]
Security	Use environment secrets for better security practices. For better security practices, consider using environment secrets instead of repository secrets for OPENAI_KEY and GITHUB_TOKEN if this workflow is used across multiple repositories. Environment secrets allow for finer-grained access control. .github/workflows/pr-agent.yml [17-18] -OPENAI_KEY: ${{ secrets.OPEN_AI_KEY }} -GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +OPENAI_KEY: ${{ env.OPENAI_KEY }} +GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. 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 improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - 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.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

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 improve usage page for a more comprehensive guide on using this tool.