docs: Add git-cliff configuration, update changelog#1129
Conversation
WalkthroughThe Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
🧙 Sourcery has finished reviewing your pull request! Tips
|
There was a problem hiding this comment.
We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.
|
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (10)
changelog.md (10)
98-98: Typographical error: Use "properly" instead of "proper".The word “proper” is an adjective and doesn’t fit in this context. Did you mean the adverb “properly”?
- Fix `make_release.yml` to proper detect release, attempt 3 + Fix `make_release.yml` to properly detect release, attempt 3Tools
LanguageTool
[misspelling] ~98-~98: The word “proper” is an adjective and doesn’t fit in this context. Did you mean the adverb “properly”?
Context: ...pull/1126)) - Fixmake_release.ymlto proper detect release, attempt 3 ([#1127](http...(ADJECTIVE_ADVERB)
88-88: Typographical error: Use "macOS" instead of "macos".The operating system from Apple is written “macOS”.
- Bump macos runners to macos-13 (both azure and GHA) + Bump macOS runners to macOS-13 (both azure and GHA)Tools
LanguageTool
[grammar] ~88-~88: The operating system from Apple is written “macOS”.
Context: ...m//pull/1103)) - Bump macos runners to macos-13 (both azure and GHA...(MAC_OS)
125-125: Grammar correction: Use "selecting" instead of "select".Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
- Do not allow to select and render corrupted batch plans + Do not allow selecting and rendering corrupted batch plansTools
LanguageTool
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
154-154: Grammar correction: Add a comma before ‘but’.Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
- read tiff files with double `Q` in axes but one related to dummy dimension + read tiff files with double `Q` in axes, but one related to dummy dimensionTools
LanguageTool
[uncategorized] ~154-~154: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... read tiff files with doubleQin axes but one related to dummy dimension ([#992](...(COMMA_COMPOUND_SENTENCE_2)
155-155: Typographical error: Capitalize "Excel".Capitalize this word if you mean the computer program “Excel”.
- when saving calculation plan to excel file + when saving calculation plan to Excel fileTools
LanguageTool
[grammar] ~155-~155: Capitalize this word if you mean the computer program “Excel”.
Context: ...d state when saving calculation plan to excel file ([#995](https://github.com/4DNucle...(ON_EXCEL)
183-183: Grammar correction: Use "seeing" instead of "see".Did you mean “seeing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
- Allow to see underlying exception when show warning caused by exception + Allow seeing underlying exception when show warning caused by exceptionTools
LanguageTool
[grammar] ~183-~183: Did you mean “seeing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...m//pull/802)) - Allow to see underlying exception when show warning ...(ALLOW_TO)
323-323: Grammar correction: Use "customize" instead of "customize".The preposition ‘to’ may be missing (allow someone to do something).
- Allow customize settings directory using the `PARTSEG_SETTINGS_DIR` environment variable + Allow to customize settings directory using the `PARTSEG_SETTINGS_DIR` environment variableTools
LanguageTool
[grammar] ~323-~323: The preposition ‘to’ may be missing (allow someone to do something).
Context: ...m//pull/733)) - Allow customize settings directory using the `PARTSEG_S...(ALLOW_TO_DO)
335-335: Grammar correction: Use "do not create" instead of "to do not create".Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
- Fix bug in cut with roi to do not make black artifacts + Fix bug in cut with roi to not make black artifactsTools
LanguageTool
[grammar] ~335-~335: Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
Context: ...eg/pull/765)) - Fix bug in cut with roi to do not make black artifacts ([#767](https://gi...(NEGATED_INFINITIVE)
434-434: Grammar correction: Use "creation" instead of "create".The word ‘create’ is a verb. Did you mean the noun “creation”?
- Refactor the create batch plan widgets and add test for it + Refactor the creation of batch plan widgets and add test for itTools
LanguageTool
[grammar] ~434-~434: The word ‘create’ is a verb. Did you mean the noun “creation”?
Context: .../598)) ### 🚜 Refactor - Refactor the create batch plan widgets and add test for it ...(PREPOSITION_VERB)
453-453: Typographical error: Capitalize "Excel".Capitalize this word if you mean the computer program “Excel”.
- import calculation plan from batch result excel file + import calculation plan from batch result Excel fileTools
LanguageTool
[grammar] ~453-~453: Capitalize this word if you mean the computer program “Excel”.
Context: ...port calculation plan from batch result excel file ([#567](https://github.com/4DNucle...(ON_EXCEL)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- changelog.md (1 hunks)
- cliff.toml (1 hunks)
Files not summarized due to errors (1)
- changelog.md: Error: Message exceeds token limit
Additional context used
LanguageTool
changelog.md
[grammar] ~88-~88: The operating system from Apple is written “macOS”.
Context: ...m//pull/1103)) - Bump macos runners to macos-13 (both azure and GHA...(MAC_OS)
[misspelling] ~98-~98: The word “proper” is an adjective and doesn’t fit in this context. Did you mean the adverb “properly”?
Context: ...pull/1126)) - Fixmake_release.ymlto proper detect release, attempt 3 ([#1127](http...(ADJECTIVE_ADVERB)
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
[uncategorized] ~154-~154: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... read tiff files with doubleQin axes but one related to dummy dimension ([#992](...(COMMA_COMPOUND_SENTENCE_2)
[grammar] ~155-~155: Capitalize this word if you mean the computer program “Excel”.
Context: ...d state when saving calculation plan to excel file ([#995](https://github.com/4DNucle...(ON_EXCEL)
[grammar] ~183-~183: Did you mean “seeing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...m//pull/802)) - Allow to see underlying exception when show warning ...(ALLOW_TO)
[grammar] ~323-~323: The preposition ‘to’ may be missing (allow someone to do something).
Context: ...m//pull/733)) - Allow customize settings directory using the `PARTSEG_S...(ALLOW_TO_DO)
[grammar] ~335-~335: Are you sure the preposition ‘to’ or the verb ‘do’ is correct here?
Context: ...eg/pull/765)) - Fix bug in cut with roi to do not make black artifacts ([#767](https://gi...(NEGATED_INFINITIVE)
[grammar] ~434-~434: The word ‘create’ is a verb. Did you mean the noun “creation”?
Context: .../598)) ### 🚜 Refactor - Refactor the create batch plan widgets and add test for it ...(PREPOSITION_VERB)
[grammar] ~453-~453: Capitalize this word if you mean the computer program “Excel”.
Context: ...port calculation plan from batch result excel file ([#567](https://github.com/4DNucle...(ON_EXCEL)
Additional comments not posted (15)
cliff.toml (10)
10-13: Header template looks good!The header template is correctly defined.
16-30: Body template looks good!The body template is correctly defined and uses Tera template syntax.
32-34: Footer template looks good!The footer template is correctly defined.
38-40: Postprocessors configuration looks good!The postprocessor for replacing the repository URL is correctly defined.
44-46: Commit parsing options look good!The options for parsing conventional commits and filtering unconventional commits are correctly defined.
50-56: Commit preprocessors configuration looks good!The commit preprocessors for handling issue numbers and spelling checks are correctly defined.
60-74: Commit parsers configuration looks good!The regex patterns for parsing and grouping commits are correctly defined.
92-93: Bump strategy configuration looks good!The option for determining the version bump strategy is correctly defined.
79-84: Tag patterns configuration looks good!The regex patterns for matching and skipping git tags are correctly defined.
87-88: Sort commits configuration looks good!The option for sorting commits inside sections by oldest order is correctly defined.
changelog.md (5)
125-125: Grammar correction: Use "selecting" instead of "select".Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Tools
LanguageTool
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
125-125: Grammar correction: Use "selecting" instead of "select".Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Tools
LanguageTool
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
453-453: Typographical error: Capitalize "Excel".Capitalize this word if you mean the computer program “Excel”.
Tools
LanguageTool
[grammar] ~453-~453: Capitalize this word if you mean the computer program “Excel”.
Context: ...port calculation plan from batch result excel file ([#567](https://github.com/4DNucle...(ON_EXCEL)
125-125: Grammar correction: Use "selecting" instead of "select".Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Tools
LanguageTool
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
125-125: Grammar correction: Use "selecting" instead of "select".Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Tools
LanguageTool
[grammar] ~125-~125: Did you mean “selecting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...eome/PartSeg/pull/1016)) - Do not allow to select and render corrupted batch plans ([#101...(ALLOW_TO)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1129 +/- ##
===========================================
+ Coverage 92.93% 92.94% +0.01%
===========================================
Files 205 205
Lines 32519 32519
===========================================
+ Hits 30220 30225 +5
+ Misses 2299 2294 -5 ☔ View full report in Codecov by Sentry. |
Summary by CodeRabbit
git-cliffto streamline and automate the generation of changelogs.