Skip to content

Commit

Permalink
Document jreleaser/jreleaser#619
Browse files Browse the repository at this point in the history
  • Loading branch information
@aalmiray
aalmiray committed Dec 22, 2021
1 parent 7c2c060 commit c9e19a3
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 85 deletions.
177 changes: 92 additions & 85 deletions docs/modules/configuration/pages/release/changelog.adoc
View file
Expand Up @@ -84,12 +84,15 @@ release:
title: '[chore]'
categories:
- title: '🚀 Features'
key: 'features'
labels:
- 'feature'
- title: '✅ Issues'
key: 'issues'
labels:
- 'issue'
- title: '🧰 Tasks'
key: 'tasks'
labels:
- 'task'
replacers:
Expand Down Expand Up @@ -128,20 +131,20 @@ applied:

[%header]
|===
| Category | Order | Label | Prefix | Order
| 🔀 Merge | 0 | merge | Merge pull | 0
| 🔀 Merge | 0 | merge | Merge branch | 5
| 🚀 Features | 10 | feat | feat: | 50
| 🐛 Fixes | 20 | fix | fix: | 60
| ♻️ ️Changes | 30 | perf | perf: | 70
| ♻️ ️Changes | 30 | refactor | refactor: | 80
| ♻️ ️Changes | 30 | revert | revert: | 90
| ♻️ ️Changes | 30 | style | style: | 100
| 🧰 Tasks | 40 | chore | chore: | 20
| 🛠 Build | 50 | test | test: | 110
| 🛠 Build | 50 | build | build: | 10
| 🛠 Build | 50 | ci | ci: | 30
| 📝 Documentation | 60 | docs | docs: | 40
| Category | Key | Order | Label | Prefix | Order
| 🔀 Merge | merge | 0 | merge | Merge pull | 0
| 🔀 Merge | merge | 0 | merge | Merge branch | 5
| 🚀 Features | features | 10 | feat | feat: | 50
| 🐛 Fixes | fixes | 20 | fix | fix: | 60
| 🔄 Changes | changes | 30 | perf | perf: | 70
| 🔄 Changes | changes | 30 | refactor | refactor: | 80
| 🔄 Changes | changes | 30 | revert | revert: | 90
| 🔄 Changes | changes | 30 | style | style: | 100
| 🧰 Tasks | tasks | 40 | chore | chore: | 20
| 🛠 Build | build | 50 | test | test: | 110
| 🛠 Build | build | 50 | build | build: | 10
| 🛠 Build | build | 50 | ci | ci: | 30
| 📝 Documentation | docs | 60 | docs | docs: | 40
|===

You may define an optional scope as part of the prefix, such as `fix(core)` or `feat(plugins)`. A `!` in the prefix will
Expand Down Expand Up @@ -170,6 +173,8 @@ ea65d99 (core) Add missing checks in loader
8ac258c 🚨 (engine) Plugins require custom classloader
----

NOTE: Use the `key` value to match a category and change its settings.

==== Example

The following configuration
Expand Down Expand Up @@ -228,78 +233,78 @@ image::ROOT:jreleaser-changelog-preset-conventional-commits.png[]
Commit messages that follow the link:https://gitmoji.dev/[Gitmoji] convention will be automatically labeled and
categorized. The following table shows mappings that you may use when this preset is applied:

[%header, cols="<,<,<,^,<2"]
[%header, cols="<,<,<,<,^,<2"]
|===
| Category | Order | Label | Emoji | Keyword
| Merge | 0 | merge | 🔀 | :twisted_rightwards_arrows:
| Added | 10 | added | ✨ | :sparkles:
| Added | 10 | added | 🎉 | :tada:
| Added | 10 | added | ✅ | :white_check_mark:
| Added | 10 | added | 👷 | :construction_worker:
| Added | 10 | added | 📈 | :chart_with_upwards_trend:
| Added | 10 | added | ➕ | :heavy_plus_sign:
| Added | 10 | added | 🔊 | :loud_sound:
| Changed | 20 | changed | 🎨 | :art:
| Changed | 20 | changed | ⚡️ | :zap:
| Changed | 20 | changed | 💄 | :lipstick:
| Changed | 20 | changed | 🚨 | :rotating_light:
| Changed | 20 | changed | 📌 | :pushpin:
| Changed | 20 | changed | ♻️ | :recycle:
| Changed | 20 | changed | 🔧 | :wrench:
| Changed | 20 | changed | 🔨 | :hammer:
| Changed | 20 | changed | ⏪ | :rewind:
| Changed | 20 | changed | 👽 | :alien:
| Changed | 20 | changed | 🚚 | :truck:
| Changed | 20 | changed | 🍱 | :bento:
| Changed | 20 | changed | ♿️ | :wheelchair:
| Changed | 20 | changed | 💬 | :speech_balloon:
| Changed | 20 | changed | 🗃 | :card_file_box:
| Changed | 20 | changed | 🚸 | :children_crossing:
| Changed | 20 | changed | 🏗 | :building_construction:
| Changed | 20 | changed | 📱 | :iphone:
| Changed | 20 | changed | 📦 | :package:
| Breaking | 30 | breaking_changes | 💥 | :boom:
| Deprecated | 40 | deprecated | 🗑 | :wastebasket:
| Removed | 50 | Removed | ➖ | :heavy_minus_sign:
| Removed | 50 | Removed | 🔥 | :fire:
| Removed | 50 | Removed | 🔇 | :mute:
| Removed | 50 | Removed | ⚰️ | :coffin:
| Fixed | 60 | fixed | 🐛 | :bug:
| Fixed | 60 | fixed | 🚑 | :ambulance:
| Fixed | 60 | fixed | 🍎 | :apple:
| Fixed | 60 | fixed | 🍏 | :green_apple:
| Fixed | 60 | fixed | 🐧 | :penguin:
| Fixed | 60 | fixed | 🏁 | :checkered_flag:
| Fixed | 60 | fixed | 🤖 | :robot:
| Fixed | 60 | fixed | 💚 | :green_heart:
| Fixed | 60 | fixed | ✏️ | :pencil2:
| Fixed | 60 | fixed | 🩹️ | :adhesive_bandage:
| Security | 70 | security | 🔒️ | :lock:
| Security | 70 | security | 🛂 | :passport_control:
| Documentation | 80 | documentation | 📝 | :pencil:
| Documentation | 80 | documentation | 📝 | :memo:
| Documentation | 80 | documentation | 🌐 | :globe_with_meridians:
| Documentation | 80 | documentation | 📄 | :page_facing_up:
| Documentation | 80 | documentation | 💡 | :bulb:
| Dependencies | 90 | dependencies | ⬆️ | :arrow_up:
| Dependencies | 90 | dependencies | ⬇️ | :arrow_down:
| Miscellaneous | 100 | misc | 💩 | :poop:
| Miscellaneous | 100 | misc | 🚧 | :construction:
| Miscellaneous | 100 | misc | 🍻 | :beers:
| Miscellaneous | 100 | misc | 👥 | :busts_in_silhouette:
| Miscellaneous | 100 | misc | 🤡 | :clown_face:
| Miscellaneous | 100 | misc | 🥚 | :egg:
| Miscellaneous | 100 | misc | 🙈 | :see_no_evil:
| Miscellaneous | 100 | misc | 📸 | :camera_flash:
| Miscellaneous | 100 | misc | ⚗️ | :alembic:
| Miscellaneous | 100 | misc | 🔍 | :mag:
| Miscellaneous | 100 | misc | 🥅 | :goal_net:
| Miscellaneous | 100 | misc | 🧐 | :monocle_face:
| Miscellaneous | 100 | misc | 🧪 | :test_tube:
| Miscellaneous | 100 | misc | 👔 | :necktie:
| Miscellaneous | 100 | misc | 👌 | :ok_hand:
| Release | 110 | release | 🚀 | :rocket:
| Release | 110 | release | 🔖 | :bookmark:
| Category | Key | Order | Label | Emoji | Keyword
| 🔀 Merge | merge | 0 | merge | 🔀 | :twisted_rightwards_arrows:
| 🚀 Added | added | 10 | added | ✨ | :sparkles:
| 🚀 Added | added | 10 | added | 🎉 | :tada:
| 🚀 Added | added | 10 | added | ✅ | :white_check_mark:
| 🚀 Added | added | 10 | added | 👷 | :construction_worker:
| 🚀 Added | added | 10 | added | 📈 | :chart_with_upwards_trend:
| 🚀 Added | added | 10 | added | ➕ | :heavy_plus_sign:
| 🚀 Added | added | 10 | added | 🔊 | :loud_sound:
| 🔄️ Changed | changed | 20 | changed | 🎨 | :art:
| 🔄️ Changed | changed | 20 | changed | ⚡️ | :zap:
| 🔄️ Changed | changed | 20 | changed | 💄 | :lipstick:
| 🔄️ Changed | changed | 20 | changed | 🚨 | :rotating_light:
| 🔄️ Changed | changed | 20 | changed | 📌 | :pushpin:
| 🔄️ Changed | changed | 20 | changed | ♻️ | :recycle:
| 🔄️ Changed | changed | 20 | changed | 🔧 | :wrench:
| 🔄️ Changed | changed | 20 | changed | 🔨 | :hammer:
| 🔄️ Changed | changed | 20 | changed | ⏪ | :rewind:
| 🔄️ Changed | changed | 20 | changed | 👽 | :alien:
| 🔄️ Changed | changed | 20 | changed | 🚚 | :truck:
| 🔄️ Changed | changed | 20 | changed | 🍱 | :bento:
| 🔄️ Changed | changed | 20 | changed | ♿️ | :wheelchair:
| 🔄️ Changed | changed | 20 | changed | 💬 | :speech_balloon:
| 🔄️ Changed | changed | 20 | changed | 🗃 | :card_file_box:
| 🔄️ Changed | changed | 20 | changed | 🚸 | :children_crossing:
| 🔄️ Changed | changed | 20 | changed | 🏗 | :building_construction:
| 🔄️ Changed | changed | 20 | changed | 📱 | :iphone:
| 🔄️ Changed | changed | 20 | changed | 📦 | :package:
| 🚨 Breaking | breaking | 30 | breaking_changes | 💥 | :boom:
| 💥 Deprecated | deprecated | 40 | deprecated | 🗑 | :wastebasket:
| 🗑 Removed | removed | 50 | Removed | ➖ | :heavy_minus_sign:
| 🗑 Removed | removed | 50 | Removed | 🔥 | :fire:
| 🗑 Removed | removed | 50 | Removed | 🔇 | :mute:
| 🗑 Removed | removed | 50 | Removed | ⚰️ | :coffin:
| 🐛 Fixed | fixed | 60 | fixed | 🐛 | :bug:
| 🐛 Fixed | fixed | 60 | fixed | 🚑 | :ambulance:
| 🐛 Fixed | fixed | 60 | fixed | 🍎 | :apple:
| 🐛 Fixed | fixed | 60 | fixed | 🍏 | :green_apple:
| 🐛 Fixed | fixed | 60 | fixed | 🐧 | :penguin:
| 🐛 Fixed | fixed | 60 | fixed | 🏁 | :checkered_flag:
| 🐛 Fixed | fixed | 60 | fixed | 🤖 | :robot:
| 🐛 Fixed | fixed | 60 | fixed | 💚 | :green_heart:
| 🐛 Fixed | fixed | 60 | fixed | ✏️ | :pencil2:
| 🐛 Fixed | fixed | 60 | fixed | 🩹️ | :adhesive_bandage:
| 🔒️ Security | security | 70 | security | 🔒️ | :lock:
| 🔒️ Security | security | 70 | security | 🛂 | :passport_control:
| 📦 Dependencies | deps | 80 | dependencies | ⬆️ | :arrow_up:
| 📦 Dependencies | deps | 80 | dependencies | ⬇️ | :arrow_down:
| 📝 Documentation | docs | 90 | documentation | 📝 | :pencil:
| 📝 Documentation | docs | 90 | documentation | 📝 | :memo:
| 📝 Documentation | docs | 90 | documentation | 🌐 | :globe_with_meridians:
| 📝 Documentation | docs | 90 | documentation | 📄 | :page_facing_up:
| 📝 Documentation | docs | 90 | documentation | 💡 | :bulb:
| 🎲 Miscellaneous | misc | 100 | misc | 💩 | :poop:
| 🎲 Miscellaneous | misc | 100 | misc | 🚧 | :construction:
| 🎲 Miscellaneous | misc | 100 | misc | 🍻 | :beers:
| 🎲 Miscellaneous | misc | 100 | misc | 👥 | :busts_in_silhouette:
| 🎲 Miscellaneous | misc | 100 | misc | 🤡 | :clown_face:
| 🎲 Miscellaneous | misc | 100 | misc | 🥚 | :egg:
| 🎲 Miscellaneous | misc | 100 | misc | 🙈 | :see_no_evil:
| 🎲 Miscellaneous | misc | 100 | misc | 📸 | :camera_flash:
| 🎲 Miscellaneous | misc | 100 | misc | ⚗️ | :alembic:
| 🎲 Miscellaneous | misc | 100 | misc | 🔍 | :mag:
| 🎲 Miscellaneous | misc | 100 | misc | 🥅 | :goal_net:
| 🎲 Miscellaneous | misc | 100 | misc | 🧐 | :monocle_face:
| 🎲 Miscellaneous | misc | 100 | misc | 🧪 | :test_tube:
| 🎲 Miscellaneous | misc | 100 | misc | 👔 | :necktie:
| 🎲 Miscellaneous | misc | 100 | misc | 👌 | :ok_hand:
| 🏁 Release | release | 110 | release | 🚀 | :rocket:
| 🏁 Release | release | 110 | release | 🔖 | :bookmark:
|===

The following commit messages are equivalent:
Expand All @@ -312,6 +317,8 @@ The following commit messages are equivalent:

Keywords are automatically replaced by their corresponding emoji in the generated changelog.

NOTE: Use the `key` value to match a category and change its settings.

==== Example

The following configuration
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/configuration/partials/release/gradle/changelog.adoc
View file
Expand Up @@ -132,7 +132,10 @@
// Defaults are shown.
// icon:dot-circle[]
category {
// Used for rendering
title = '🚀 Features'
// Used for identifying the category
key = 'features'
labels = [
'feature',
'enhancement'
Expand All @@ -141,6 +144,7 @@
}
category {
title = '🐛 Bug Fixes'
key = 'fixes'
// You may override the format per category.
format '- {{commitShortHash}} {{commitBody}}'
labels = [
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/configuration/partials/release/json/changelog.adoc
View file
Expand Up @@ -139,7 +139,10 @@
// icon:dot-circle[]
"categories": [
{
// Used for rendering
"title": "🚀 Features",
// Used for identifying the category
"key": "features",
"labels": [
"feature",
"enhancement"
Expand All @@ -148,6 +151,7 @@
},
{
"title": "🐛 Bug Fixes",
"key": "fixes",
// You may override the format per category.
"format": "- {{commitShortHash}} {{commitBody}}",
"labels": [
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/configuration/partials/release/maven/changelog.adoc
View file
Expand Up @@ -195,12 +195,16 @@
-->
<categories>
<category>
<!-- Used for rendering -->
<title>🚀 Features</title>
<!-- Used for identifying the category -->
<key>features</key>
<labels>feature,enhancement</labels>
<order>1</order>
</category>
<category>
<title>🐛 Bug Fixes</title>
<key>fixes</key>
<!--
You may override the format per category.
-->
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/configuration/partials/release/toml/changelog.adoc
View file
Expand Up @@ -128,12 +128,16 @@
# Defaults are shown.
# icon:dot-circle[]
pass:[[[]release.{gitservice_id}.changelog.categoriespass:[]]]
# Used for rendering
title = "🚀 Features"
# Used for identifying the category
key = "features"
labels = ["feature", "enhancement"]
order = 1

pass:[[[]release.{gitservice_id}.changelog.categoriespass:[]]]
title = "🐛 Bug Fixes"
key = "fixes"
# You may override the format per category.
format = "- {{commitShortHash}} {{commitBody}}"
labels = ["bug", "fix"]
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/configuration/partials/release/yaml/changelog.adoc
View file
Expand Up @@ -133,12 +133,16 @@
# Defaults are shown.
# icon:dot-circle[]
categories:
# Used for rendering
- title: '🚀 Features'
# Used for identifying the category
key: 'features'
labels:
- 'feature'
- 'enhancement'
order: 1
- title: '🐛 Bug Fixes'
key: 'fixes'
# You may override the format per category.
format: '- {{commitShortHash}} {{commitBody}}'
labels:
Expand Down

0 comments on commit c9e19a3

Please sign in to comment.