๐ fix(changelog): fix subCommitScope default value and reduceHeadingLevel #670
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The commit includes changes in the packages/changelog/.changelogrc.js, packages/changelog/src/finalizeContext/index.ts, and packages/changelog/src/templates files. It fixes the default value of subCommitScope from an empty string to null when it is not defined in customConfig.scopeDisplayName. The change ensures that commits with no scope are appropriately sorted in commitGroups.
Codecov Report
@@ Coverage Diff @@
## master #670 +/- ##
==========================================
+ Coverage 76.59% 86.55% +9.96%
==========================================
Files 26 26
Lines 282 305 +23
Branches 73 81 +8
==========================================
+ Hits 216 264 +48
+ Misses 61 36 -25
Partials 5 5
๐ฃ Weโre building smart automated test selection to slash your CI/CD build times. Learn more |
This commit updates the display names for `build`, `chore`, and `ci` commit types in the `typeDisplayName` module of the changelog transformer. The emojis used to represent these types have been changed from ๐ฆ, ๐ง, and ๐ท to ๐ท, ๐ซ, and ๐ง respectively. This change applies to both English and Chinese display names. The update only affects style and does not impact the functionality of the code.
โฆdisplay name This commit adds support for a custom type display map and scope display name to the changelog package. The `customTypeMap` property in the `ChangelogConfig` interface allows users to define a custom type display map, while the `scopeDisplayName` property allows users to specify a default display name for all scopes. These new features can be configured in the `customConfig.ts` file. This commit also includes some code refactoring and dependency updates.
โฆtScope in finalizeContext test This commit refactors the code in finalizeContext index.test.ts file by using null instead of an empty string for subCommitScope. This change is done to fix a bug related to custom configuration scopeDisplayName. The commit does not add any new features nor affect performance.
โฆtTypes in customTypeMap parameter
This commit refactors the finalizeContext test in the changelog package by removing unused imports, variables, and commented-out code. It also improves readability by removing unnecessary ternary operations and renaming variables for clarity.
โฆtemplate
This commit adds an option to show authors' avatars in the summary template of the changelog package. The new functionality is achieved by introducing a new handlebar partial called "summary-avatar," which contains the code that generates avatars for each author. The mainTemplate variable is updated to include this new partial and replace the {{gitUserInfo}} placeholder with the appropriate code based on the showAuthor and showAuthorAvatar options from the customConfig object.
|
done |
arvinxx
reviewed
Jun 11, 2023
| @@ -33,13 +33,16 @@ | |||
| "test": "jest" | |||
| }, | |||
| "dependencies": { | |||
| "@ardatan/sync-fetch": "^0", | |||
There was a problem hiding this comment.
ๅพๅๆ ^0.x
^0 ไธไผๅปๆพๆๆฐ็็ๆฌ
There was a problem hiding this comment.
ไปฅๅไธบๅฅๆฏ็จ่ฟไธชๅ ็ fetch ๏ผๆฏๆไปไน็นๆฎ็ไน๏ผ
There was a problem hiding this comment.
ๆ่ฏไธๆฅ 0 ไผๅปๆพๆๆฐ็ๆฌ่ฏถ....?
There was a problem hiding this comment.
ไปฅๅไธบๅฅๆฏ็จ่ฟไธชๅ ็ fetch ๏ผๆฏๆไปไน็นๆฎ็ไน๏ผ
fetch ็ๅๆญฅ็ๆฌ
|
close #156 |
github-actions bot
pushed a commit
that referenced
this pull request
Jun 12, 2023
### [Version 1.5.2](https://github.com/arvinxx/gitmoji-commit-workflow/compare/conventional-changelog-gitmoji-config@1.5.1...conventional-changelog-gitmoji-config@1.5.2) <sup>Released on **2023-06-12**</sup> #### ๐ Bug Fixes - **changelog**: Fix subCommitScope default value and reduceHeadingLevel. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### What's fixed * **changelog**: Fix subCommitScope default value and reduceHeadingLevel, closes [#670](#670) ([e4da993](e4da993)) </details> <div align="right"> [](#readme-top) </div>
|
๐ This PR is included in version 1.5.3 ๐ The release is available on npm package (@latest dist-tag) Your semantic-release bot ๐ฆ๐ |
|
๐ This PR is included in version 1.5.2 ๐ The release is available on npm package (@latest dist-tag) Your semantic-release bot ๐ฆ๐ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The commit includes changes in the packages/changelog/.changelogrc.js, packages/changelog/src/finalizeContext/index.ts, and packages/changelog/src/templates files. It fixes the default value of subCommitScope from an empty string to null when it is not defined in customConfig.scopeDisplayName. The change ensures that commits with no scope are appropriately sorted in commitGroups.