search

Hu-Fi / Mr.Market

Mr. Market is the exchange oracle of HuFi, and a CeFi crypto bot on Mixin Messenger
https://mr-market-one.vercel.app
GNU Affero General Public License v3.0
1 stars 6 forks source link

add pr-review #32

Closed posix4e closed 6 months ago

posix4e commented 6 months ago

Type

enhancement

Description

Changes walkthrough

Relevant files
Enhancement
ai-review.yml
Integrate PR Agent GitHub Action for Automated Reviews     
.github/workflows/ai-review.yml
  • Added a new GitHub Actions workflow to trigger on pull request events
    and issue comment events.
  • Configured the workflow to run on ubuntu-latest.
  • Set permissions for issues, pull-requests, and contents to write.
  • Included a step to use Codium-ai/pr-agent@main with environment
    variables for OPENAI_KEY and GITHUB_TOKEN.
    		• +27/-0   

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

    vercel[bot] commented 6 months ago

    The latest updates on your projects. Learn more about Vercel for Git ↗︎

    Name Status Preview Comments Updated (UTC)
    mr-market ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 2, 2024 0:43am
    mr-market-back ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 2, 2024 0:43am
    github-actions[bot] commented 6 months ago

    PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/1ef731b35bbf33709e154d87cb86a9420b7615e2)

    github-actions[bot] commented 6 months ago

    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 configuration is simple and focuses on automating PR reviews and responding to user comments, which doesn't involve complex logic.
    🧪 Relevant tests No
    🔍 Possible issues The workflow triggers on both pull request and issue comment events but does not specify any conditions for when the automated actions should run. This could potentially lead to unnecessary runs, consuming GitHub Actions minutes and possibly reaching rate limits.
    🔒 Security concerns Yes, because the workflow uses secrets (`OPENAI_KEY` and `GITHUB_TOKEN`) which are sensitive. It's important to ensure that the `Codium-ai/pr-agent@main` action is from a trusted source to prevent any potential misuse of these secrets.
    Code feedback:
    relevant file.github/workflows/ai-review.yml
    suggestion       Consider adding conditions to limit when the automated actions should run, especially for issue comment events, to avoid unnecessary workflow runs. For example, you could check the content of the comment and only trigger the workflow for specific commands. [important]
    relevant lineissue_comment:
    relevant file.github/workflows/ai-review.yml
    suggestion       Ensure that the `Codium-ai/pr-agent@main` action is from a trusted source and regularly maintained. Using actions from untrusted sources can pose a security risk, especially when handling secrets. [important]
    relevant lineuses: Codium-ai/pr-agent@main
    ✨ Review tool usage guide:
    **Overview:** The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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.
    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 \**: 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment.
    See the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.
    github-actions[bot] commented 6 months ago

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Security
    Limit workflow permissions to the minimum required. ___ **It's recommended to limit the permissions to the minimum required for the workflow to
    function. This enhances security by following the principle of least privilege. For
    instance, if the workflow does not need to write to issues, consider setting issues: read
    or removing the permission if not needed at all.** [.github/workflows/ai-review.yml [16-20]](https://github.com/Hu-Fi/Mr.Market/pull/32/files#diff-105e0011bdd1445d561435b79b1c776c324c9ea99ac6c3649f8bf4895399fa41R16-R20) ```diff permissions: - issues: write + issues: read pull-requests: write - contents: write + contents: read ```
    Best practice
    Use a specific version for GitHub Actions to ensure stability. ___ **Consider specifying a version for the Codium-ai/pr-agent@main action to ensure stability
    and predictability of your workflow. Using a specific version or commit hash instead of
    main can prevent unexpected changes from affecting your workflow.** [.github/workflows/ai-review.yml [24]](https://github.com/Hu-Fi/Mr.Market/pull/32/files#diff-105e0011bdd1445d561435b79b1c776c324c9ea99ac6c3649f8bf4895399fa41R24-R24) ```diff -uses: Codium-ai/pr-agent@main +uses: Codium-ai/pr-agent@v1.0.0 ```
    Maintainability
    Add names to all steps for better readability and maintainability. ___ **To improve the maintainability and readability of the workflow, consider adding a name
    attribute to each step. This will make it easier to identify and troubleshoot steps within
    the GitHub Actions logs.** [.github/workflows/ai-review.yml [21-24]](https://github.com/Hu-Fi/Mr.Market/pull/32/files#diff-105e0011bdd1445d561435b79b1c776c324c9ea99ac6c3649f8bf4895399fa41R21-R24) ```diff steps: + - name: Checkout code + uses: actions/checkout@v2 - name: PR Agent action step id: pragent uses: Codium-ai/pr-agent@main ```
    ✨ 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ```
    Enabling\disabling automation
    When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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 :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) 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 \**: 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment.
    See the [improve usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) page for a more comprehensive guide on using this tool.