Adds PR agent to repository

[leonardocustodio]

Type

Enhancement

---

Description

• This PR introduces a new GitHub Actions workflow, pr_agent.yml, which is designed to run a PR Agent on every pull request and respond to user comments.
• The workflow runs on the latest version of Ubuntu and has write permissions for issues, pull requests, and contents.
• The PR Agent action from Codium-ai/pr-agent is used in this workflow.
• The workflow uses the OPENAI_KEY and GITHUB_TOKEN environment variables, fetched from the repository's secrets.

---

Changes walkthrough

Relevant files

Configuration changes

pr_agent.yml Addition of PR Agent Workflow                                                                        .github/workflows/pr_agent.yml Added a new workflow that triggers on pull requests and issue comments. The workflow runs on the latest version of Ubuntu. The workflow has write permissions for issues, pull requests, and contents. The workflow uses the PR Agent action from Codium-ai/pr-agent. The workflow uses the OPENAI_KEY and GITHUB_TOKEN environment variables. +20/-0

---

✨ 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.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (42cb6fd) 46.91% compared to head (fb9c26c) 46.91%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #407   +/-   ##
=======================================
  Coverage   46.91%   46.91%           
=======================================
  Files         164      164           
  Lines        8926     8926           
=======================================
  Hits         4188     4188           
  Misses       4738     4738           

Flag	Coverage Δ
polkadart	16.85% <ø> (ø)
polkadart_cli	12.05% <ø> (ø)
polkadart_keyring	77.24% <ø> (ø)
polkadart_scale_codec	54.93% <ø> (ø)
sr25519	85.91% <ø> (ø)
ss58	96.87% <ø> (ø)
substrate_bip39	63.35% <ø> (ø)
substrate_metadata	87.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[github-actions]

PR Description updated to latest commit (fb9c26c)

[github-actions]

PR Analysis

• 🎯 Main theme: Addition of a PR Agent Workflow
• 📝 PR summary: This PR introduces a new GitHub Actions workflow, pr_agent.yml, which is designed to run a PR Agent on every pull request and respond to user comments. The workflow uses the PR Agent action from Codium-ai/pr-agent and requires the OPENAI_KEY and GITHUB_TOKEN environment variables.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the PR is straightforward and only introduces a new GitHub Actions workflow.
• 🔒 Security concerns: Yes, because the PR uses secrets.OPENAI_KEY and secrets.GITHUB_TOKEN. It's important to ensure these secrets are securely stored and only accessible to trusted parties.

PR Feedback

💡 General suggestions: The PR is well-structured and the addition of the PR Agent workflow could potentially improve the efficiency of handling pull requests. However, it would be beneficial to include some tests to ensure the workflow behaves as expected.

🤖 Code feedback:

---

relevant file	.github/workflows/pr_agent.yml
suggestion	Consider adding a failure step to handle any errors that might occur during the execution of the PR Agent action. This could help in debugging if the workflow fails. [important]
relevant line	uses: Codium-ai/pr-agent@main

---

---

✨ 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 'general suggestions' 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, 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.

[github-actions]

PR Code Suggestions

	Suggestions
best practice	Specify the version of the GitHub action being used.                          It's a good practice to specify the version of the action being used. This can prevent potential issues if the action is updated with breaking changes. Instead of using the main branch of the Codium-ai/pr-agent action, use a specific version. .github/workflows/pr_agent.yml [17] -uses: Codium-ai/pr-agent@main +uses: Codium-ai/[email protected] Add a timeout to your jobs to prevent them from running indefinitely.         It's a good practice to add a timeout to your jobs to prevent them from running indefinitely in case of errors. Consider adding a timeout-minutes field to your job. .github/workflows/pr_agent.yml [6-11] pr_agent_job: runs-on: ubuntu-latest + timeout-minutes: 15 permissions: issues: write pull-requests: write contents: write
security	Limit the permissions of GitHub Actions to the minimum required.              It's recommended to limit the permissions of GitHub Actions to the minimum required. In this case, it seems that the contents: write permission is not necessary for the PR agent job. Consider removing it unless it's explicitly needed. .github/workflows/pr_agent.yml [8-11] permissions: issues: write pull-requests: write - contents: write
performance	Specify the types of events that should trigger the workflow.                 The on field can be more specific to avoid unnecessary workflow runs. Instead of triggering the workflow on every pull_request event and issue_comment, you can specify <br> the <br> types <br> of <br> events <br> that <br> should <br> trigger <br> the <br> workflow. .github/workflows/pr_agent.yml [1-3] on: pull_request: + types: [opened, synchronize, reopened] issue_comment: + types: [created]

---

✨ 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.