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

chore: Add internal, refactor and more categories to release-please configuration. #258

Merged
merged 2 commits into from Apr 22, 2024

Conversation

mansenfranzen
Copy link
Owner

@mansenfranzen mansenfranzen commented Apr 22, 2024

Type

enhancement


Description

  • Expanded the release-please-config.json to include new categories for changelog generation.
  • New categories include 'style', 'refactor', 'revert', 'internal', 'deps', 'security', and 'breaking'.
  • Each new category is properly configured with a section name and visibility settings.

Changes walkthrough

Relevant files
Configuration changes
release-please-config.json
Expand Release-Please Configuration with Additional Categories

release-please-config.json

  • Added new categories for changelog generation: 'style', 'refactor',
    'revert', 'internal', 'deps', 'security', 'breaking'.
  • Each category is associated with a specific section and visibility
    setting.
  • +35/-0   

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

    @github-actions github-actions bot added the enhancement New feature or request label Apr 22, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (df7785a)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and limited to configuration updates in a JSON file. The complexity is low, and the main task is to verify the correctness of the new categories and their settings.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:

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

    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Maintainability
    Reorder properties for consistency and readability.

    Ensure consistency in the ordering of properties within each type object. The 'section'
    property should always come before the 'hidden' property for better readability and
    uniformity.

    release-please-config.json [58-60]

     {
         "type": "internal",
    -    "hidden": false,
    -    "section": "🏠 Internal Changes"
    +    "section": "🏠 Internal Changes",
    +    "hidden": false
     }
     
    Ensure property consistency across type definitions.

    Add a 'hidden' property with a value of false to the 'breaking' type object to maintain
    consistency with other type definitions.

    release-please-config.json [73-75]

     {
         "type": "breaking",
    -    "section": "💥 Breaking Changes"
    +    "section": "💥 Breaking Changes",
    +    "hidden": false
     }
     

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

    @codecov-commenter
    Copy link

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 93.63%. Comparing base (afdec96) to head (df7785a).

    Additional details and impacted files
    @@            Coverage Diff             @@
    ##             main     #258      +/-   ##
    ==========================================
    - Coverage   94.26%   93.63%   -0.63%     
    ==========================================
      Files          12       12              
      Lines        1116     1116              
    ==========================================
    - Hits         1052     1045       -7     
    - Misses         64       71       +7     

    ☔ View full report in Codecov by Sentry.
    📢 Have feedback on the report? Share it here.

    @mansenfranzen mansenfranzen merged commit 71e1c60 into main Apr 22, 2024
    34 of 38 checks passed
    @mansenfranzen mansenfranzen deleted the add_refactor_category branch April 22, 2024 09:20
    @github-actions github-actions bot mentioned this pull request Apr 12, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    None yet

    2 participants