search

mansenfranzen / autodoc_pydantic

Seamlessly integrate pydantic models in your Sphinx documentation.
MIT License
159 stars 27 forks source link

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

Closed mansenfranzen closed 7 months ago

mansenfranzen commented 7 months ago

Type

enhancement

Description

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[bot] commented 7 months ago

    PR Description updated to latest commit (https://github.com/mansenfranzen/autodoc_pydantic/commit/df7785a958ed49383cbb37e0842ed51a89e1e1ec)

    github-actions[bot] commented 7 months ago

    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](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) 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#L23) 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://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.
    github-actions[bot] commented 7 months ago

    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]](https://github.com/mansenfranzen/autodoc_pydantic/pull/258/files#diff-c55d4dcb68c348b2c06d263819702fbce72eeeb35b662956d02049a5a18fcf2bR58-R60) ```diff { "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]](https://github.com/mansenfranzen/autodoc_pydantic/pull/258/files#diff-c55d4dcb68c348b2c06d263819702fbce72eeeb35b662956d02049a5a18fcf2bR73-R75) ```diff { "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](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) 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#L78) 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://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.
    codecov-commenter commented 7 months ago

    Codecov Report

    All modified and coverable lines are covered by tests :white_check_mark:

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

    Additional details and impacted files ```diff @@ 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 ```

    :umbrella: View full report in Codecov by Sentry.
    :loudspeaker: Have feedback on the report? Share it here.