-
Notifications
You must be signed in to change notification settings - Fork 1
/
.cz.toml
142 lines (136 loc) · 8.27 KB
/
.cz.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[tool.commitizen]
name = "cz_customize"
tag_format = "v$version"
version_scheme = "pep440"
version_provider = "poetry"
update_changelog_on_bump = true
major_version_zero = true
version_files = ["pyproject.toml:^version"]
bump_message = "🔖 release: v$current_version → v$new_version"
[tool.commitizen.customize]
message_template = "{{change_type}}: {{message}}"
example = "✨ feat: this feature enables customization through config file"
schema = "<change_type>: <message>"
schema_pattern = "^(?P<emoji>[^\\s]+)\\s(?P<change_type>feat|fix|hotfix|docs|license|style|logs|rm_logs|refactor|test|release|deploy|config|scripts|ci_fix|ci_update|ui|types|lint|add_dep|rm_dep|downgrade|upgrade|pin|analytics|i18n|typos|init|wip|revert|merge|compiled|api|move|breaking|accessibility|comments|drunk|ux|architecture|gitignore|flags|catch_errors|deprecate|rm_dead_code|dev_exp|performance|rm_code|assets):\\s(?P<message>.+)"
bump_pattern = "^\\S.*(feat|fix|hotfix|breaking)"
bump_map = {"breaking" = "MAJOR", "feat" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"}
change_type_order = ["BREAKING CHANGE", "feat", "fix", "hotfix", "perf", "refactor", "docs", "style", "test", "build", "ci", "chore", "revert", "release", "wip"]
commit_parser = "^(?P<emoji>[^\\s]+)\\s(?P<change_type>feat|fix|hotfix|docs|license|style|logs|rm_logs|refactor|test|deploy|config|scripts|ci_fix|ci_update|ui|types|lint|add_dep|rm_dep|downgrade|upgrade|pin|analytics|i18n|typos|init|wip|revert|merge|compiled|api|move|breaking|accessibility|comments|drunk|ux|architecture|gitignore|flags|catch_errors|deprecate|rm_dead_code|dev_exp|performance|rm_code|assets):\\s(?P<message>.+)$"
changelog_pattern = "^\\S.*(feat|fix|hotfix|docs|style|refactor|config|scripts|breaking)?(!)?"
change_type_map = {"breaking" = "Breaking", "feat" = "Feat", "fix" = "Fix", "hotfix" = "Hotfix", "docs" = "Docs", "refactor" = "Refactor", "config" = "Config", "scripts" = "Scripts", "style" = "Style"}
info = """
This is a customized Commitizen configuration for our project.
Commit Types:
- ✨ feat: Introduce new features.
- 🐛 fix: Fix a bug.
- 🚑️ hotfix: Hotfix a bug.
- 📝 docs: Add or update documentation.
- 📄 license: Add or update license.
- 🎨 style: Improve structure/format of the code.
- 🔊 logs: Add or update logs.
- 🔇 rm_logs: Remove logs.
- ♻️ refactor: Refactor code.
- ✅ test: Add, update, or pass tests.
- 🔖 release: Release / Version tags.
- 🚀 deploy: Deploy stuff.
- 🔧 config: Add or update configuration files.
- 🔨 scripts: Add or update development scripts.
- 💚 ci_fix: Fix CI Build.
- 👷 ci_update: Add or update CI build system.
- 💄 ui: Add or update the UI and style files.
- 🏷️ types: Add or update types.
- 🚨 lint: Fix compiler/linter warnings.
- ➕ add_dep: Add a dependency.
- ➖ rm_dep: Remove a dependency.
- ⬇️ downgrade: Downgrade dependencies.
- ⬆️ upgrade: Upgrade dependencies.
- 📌 pin: Pin dependencies to specific versions.
- 📈 analytics: Add or update analytics or track code.
- 🌐 i18n: Internationalization and localization.
- ✏️ typos: Fix typos.
- 🎉 init: Begin a project.
- 🚧 wip: Work in progress.
- ⏪️ revert: Revert changes.
- 🔀 merge: Merge branches.
- 📦️ compiled: Add or update compiled files or packages.
- 👽️ api: Update code due to external API changes.
- 🚚 move: Move or rename resources (e.g., files, paths, routes).
- 💥 breaking: Introduce breaking changes.
- ♿️ accessibility: Improve accessibility.
- 💡 comments: Add or update comments in source code.
- 🍻 drunk: Write code drunkenly.
- 🚸 ux: Improve user experience/usability.
- 🏗️ architecture: Make architectural changes.
- 🙈 gitignore: Add or update a .gitignore file.
- 🚩 flags: Add, update, or remove feature flags.
- 🥅 catch_errors: Catch errors.
- 🗑️ deprecate: Deprecate code that needs to be cleaned up.
- ⚰️ rm_dead_code: Remove dead code.
- 🧑💻 dev_exp: Improve developer experience.
- ⚡️ performance: Improve performance.
- 🔥 rm_code: Remove code or files.
- 🍱 assets: Add or update assets.
Each commit message should follow this format:
<change_type>: <message>
Example:
✨ feat: Add new authentication module
"""
[[tool.commitizen.customize.questions]]
type = "list"
name = "change_type"
choices = [
{value = "✨ feat", name = "✨ feat: Introduce new features."},
{value = "🐛 fix", name = "🐛 fix: Fix a bug."},
{value = "🚑️ hotfix", name = "🚑️ hotfix: Hotfix a bug."},
{value = "📝 docs", name = "📝 docs: Add or update documentation."},
{value = "📄 license", name = "📄 license: Add or update license."},
{value = "🎨 style", name = "🎨 style: Improve structure/format of the code."},
{value = "🔊 logs", name = "🔊 logs: Add or update logs."},
{value = "🔇 rm_logs", name = "🔇 rm_logs: Remove logs."},
{value = "♻️ refactor", name = "♻️ refactor: Refactor code."},
{value = "✅ test", name = "✅ test: Add, update, or pass tests."},
{value = "🔖 release", name = "🔖 release: Release / Version tags."},
{value = "🚀 deploy", name = "🚀 deploy: Deploy stuff."},
{value = "🔧 config", name = "🔧 config: Add or update configuration files."},
{value = "🔨 scripts", name = "🔨 scripts: Add or update development scripts."},
{value = "💚 ci_fix", name = "💚 ci_fix: Fix CI Build."},
{value = "👷 ci_update", name = "👷 ci_update: Add or update CI build system."},
{value = "💄 ui", name = "💄 ui: Add or update the UI and style files."},
{value = "🏷️ types", name = "🏷️ types: Add or update types."},
{value = "🚨 lint", name = "🚨 lint: Fix compiler/linter warnings."},
{value = "➕ add_dep", name = "➕ add_dep: Add a dependency."},
{value = "➖ rm_dep", name = "➖ rm_dep: Remove a dependency."},
{value = "⬇️ downgrade", name = "⬇️ downgrade: Downgrade dependencies."},
{value = "⬆️ upgrade", name = "⬆️ upgrade: Upgrade dependencies."},
{value = "📌 pin", name = "📌 pin: Pin dependencies to specific versions."},
{value = "📈 analytics", name = "📈 analytics: Add or update analytics or track code."},
{value = "🌐 i18n", name = "🌐 i18n: Internationalization and localization."},
{value = "✏️ typos", name = "✏️ typos: Fix typos."},
{value = "🎉 init", name = "🎉 init: Begin a project."},
{value = "🚧 wip", name = "🚧 wip: Work in progress."},
{value = "⏪️ revert", name = "⏪️ revert: Revert changes."},
{value = "🔀 merge", name = "🔀 merge: Merge branches."},
{value = "📦️ compiled", name = "📦️ compiled: Add or update compiled files or packages."},
{value = "👽️ api", name = "👽️ api: Update code due to external API changes."},
{value = "🚚 move", name = "🚚 move: Move or rename resources (e.g., files, paths, routes)."},
{value = "💥 breaking", name = "💥 breaking: Introduce breaking changes."},
{value = "♿️ accessibility", name = "♿️ accessibility: Improve accessibility."},
{value = "💡 comments", name = "💡 comments: Add or update comments in source code."},
{value = "🍻 drunk", name = "🍻 drunk: Write code drunkenly."},
{value = "🚸 ux", name = "🚸 ux: Improve user experience/usability."},
{value = "🏗️ architecture", name = "🏗️ architecture: Make architectural changes."},
{value = "🙈 gitignore", name = "🙈 gitignore: Add or update a .gitignore file."},
{value = "🚩 flags", name = "🚩 flags: Add, update, or remove feature flags."},
{value = "🥅 catch_errors", name = "🥅 catch_errors: Catch errors."},
{value = "🗑️ deprecate", name = "🗑️ deprecate: Deprecate code that needs to be cleaned up."},
{value = "⚰️ rm_dead_code", name = "⚰️ rm_dead_code: Remove dead code."},
{value = "🧑💻 dev_exp", name = "🧑💻 dev_exp: Improve developer experience."},
{value = "⚡️ performance", name = "⚡️ performance: Improve performance."},
{value = "🔥 rm_code", name = "🔥 rm_code: Remove code or files."},
{value = "🍱 assets", name = "🍱 assets: Add or update assets."}
]
message = "Select the type of change you are committing"
[[tool.commitizen.customize.questions]]
type = "input"
name = "message"
message = "Please input commit message body:\n"