✨🐛💥 A semantic-release plugin for gitmojis. Different from conventional changelog, Gitmoji commits are used to determine a release type and generate release notes.
Gitmoji "🚧" represents "work in progress" commit, which indicates that a new feature may be composed of several 🚧 commits and a final commit such as ✨ or 🐛 .
Those 🚧 commits and a final commit in a series can be considered as a task for a specific purpose.
Therefore, we can place a task identifier (e.g. wip#1, wip#new-feature) in the footer of a commit message to recognize which task a commit belongs to.
Finally, in the release notes, we can show the final commit as a main entry, and list the 🚧 commits of the same task following the main entry to fully describe how this feature or bug fix is made.
Definitions
wip#<unique_name>
<unique_name> should be:
an issue number.
a string of unique name, which contains only alphabets, numeric, hyphens and underlines.
Behaviors
If <unique_name> is a number, the task identifier can be resolved to an issue link.
If a 🚧 commit contains only one related issue w/o wip#<unique_name>, the issue is treated as the task identifier, i.e. wip#<issue_no>.
Gitmoji
"🚧"
represents "work in progress" commit, which indicates that a new feature may be composed of several 🚧 commits and a final commit such as ✨ or 🐛 .Those 🚧 commits and a final commit in a series can be considered as a task for a specific purpose. Therefore, we can place a task identifier (e.g.
wip#1
,wip#new-feature
) in the footer of a commit message to recognize which task a commit belongs to.Finally, in the release notes, we can show the final commit as a main entry, and list the 🚧 commits of the same task following the main entry to fully describe how this feature or bug fix is made.
Definitions
<unique_name>
should be:Behaviors
<unique_name>
is a number, the task identifier can be resolved to an issue link.wip#<unique_name>
, the issue is treated as the task identifier, i.e.wip#<issue_no>
.