-
-
Notifications
You must be signed in to change notification settings - Fork 267
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
feat: update default changelog titles #1143
base: v4
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1143 +/- ##
==========================================
+ Coverage 97.33% 97.57% +0.24%
==========================================
Files 42 55 +13
Lines 2104 2603 +499
==========================================
+ Hits 2048 2540 +492
- Misses 56 63 +7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ConventionalCommitsCz, | ||
"change_type_map", | ||
{ | ||
"feat": "Feat", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are the tests using the old format?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not want to change the tests. So I applied mocking instead to hard-coding the new values.
IMHO: For tests, the names should not matter, I guess. The point is what the values are actually used for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be a bit confusing as these are no longer the actual default
_change_type_map when someone's tracing the test cases, they might be misled
@paduszyk Hi, would it be possible for us to address #1119 (comment). I think we're really close to merging! |
I would flag this change as breaking as it means any user having a custom |
Sounds good! Let me add the label |
Bumps [mkdocs-material](https://github.com/squidfunk/mkdocs-material) from 9.5.42 to 9.5.43. - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](squidfunk/mkdocs-material@9.5.42...9.5.43) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to change the test cases
Description
This updates the default titles of the changelog's sections in
ConventionalCommitsCz
.Checklist
./scripts/format
and./scripts/test
locally to ensure this change passes linter check and testExpected behavior
Changelogs are more human-readable.
Additional context
Closes #1119.