Create pr_agent.yml

[leonardocustodio]

No description provided.

[github-actions]

PR Analysis

• 🎯 Main theme: The PR introduces a new GitHub action workflow named 'PR Agent'.
• 📝 PR summary: This PR adds a new GitHub action workflow that triggers on pull requests and issue comments. The workflow runs on the latest Ubuntu and uses the 'Codium-ai/pr-agent' action. It requires two environment variables: OPENAI_KEY and GITHUB_TOKEN, which are fetched from the repository secrets.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the PR is small and straightforward, but requires knowledge about GitHub actions.
• 🔒 Security concerns: No

PR Feedback

• 💡 General suggestions: The PR is generally well-structured and follows the standard conventions for GitHub actions. However, it would be beneficial to include a description in the PR to explain the purpose and functionality of the new workflow.

• 🤖 Code feedback:

  • relevant file: .github/workflows/pr_agent.yml
    suggestion: Consider adding a 'if' condition to the job to prevent it from running on every pull request or issue comment. This can help save resources and prevent unnecessary runs. [medium]
    relevant line: on:

  • relevant file: .github/workflows/pr_agent.yml
    suggestion: It is recommended to pin the action to a specific version instead of using @main. This can prevent potential issues if the action is updated with breaking changes. [important]
    relevant line: uses: Codium-ai/pr-agent@main

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.