Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add option to disable automatic CI feedback in configuration #873

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Apr 18, 2024

Type

documentation


Description

  • Added documentation on how to disable the automatic CI feedback tool by modifying the configuration file.
  • Included a configuration example where enable_auto_checks_feedback is set to false to prevent automatic feedback.

Changes walkthrough

Relevant files
Documentation
ci_feedback.md
Add Documentation for Disabling Automatic CI Feedback       

docs/docs/tools/ci_feedback.md

  • Added a new section on how to disable automatic CI feedback.
  • Provided a configuration snippet to disable automatic feedback.
  • +8/-0     

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

    @mrT23 mrT23 marked this pull request as ready for review April 18, 2024 13:31
    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the documentation Improvements or additions to documentation label Apr 18, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (1c8aeb2)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR is straightforward, involving only documentation changes with a clear explanation and a simple configuration example.

    🏅 Score

    95

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    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=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

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

    @Codium-ai Codium-ai deleted a comment from codiumai-pr-agent-pro bot Apr 18, 2024
    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Add a brief explanation for why disabling automatic checks might be beneficial.

    Consider providing a brief explanation or rationale for why a user might want to disable
    automatic checks. This can help users make informed decisions about configuring the tool
    to best suit their needs.

    docs/docs/tools/ci_feedback.md [26]

     ## Disabling the tool from running automatically
    +Disabling automatic checks can be useful in scenarios where manual control over feedback is preferred, or to reduce noise from frequent checks in highly active development environments.
     

    ✨ 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=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

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

    @mrT23 mrT23 merged commit e429c5d into main Apr 18, 2024
    1 check passed
    @mrT23 mrT23 deleted the tr/readme branch April 18, 2024 13:33
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant