Created
April 12, 2022 14:21
-
-
Save alanbchristie/19077203307101e9e9d52086488d4921 to your computer and use it in GitHub Desktop.
IM commitizen CHANGELOG configuration
This file contains hidden or 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
--- | |
# Commitizen custom configuration. | |
# Here we extend it to add all our recognised types into the changelog. | |
# The default ignores pretty-much anything other than 'feat' and 'fix'. | |
# | |
# See the default at... | |
# https://github.com/commitizen-tools/commitizen/ | |
# blob/095f02e6c419b60c90aa84b8cebc9e9eacc8a391/commitizen/defaults.py#L83 | |
commitizen: | |
name: cz_customize | |
# What's the first revision we're interested in? | |
# For us it's the revision we started using | |
# enforcing the use of conventional commits. | |
# | |
# Adjust this value and pick a version that represents | |
# the start of your compliance with the commit message format. | |
changelog_start_rev: 1.0.0 | |
customize: | |
schema_pattern: "^(?P<change_type>feat|fix|perf|refactor|style|test|build|docs|ci|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?" | |
commit_parser: "^(?P<change_type>feat|fix|perf|refactor|style|test|build|docs|ci|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?" | |
# The changelog_pattern identifies the commit types | |
# that will be included. | |
# Build the changelog with 'cz ch' on the staging or production branches. | |
changelog_pattern: "^(feat|fix|perf|refactor|style|test|build|docs|ci)?" | |
# A mapping of type to its group name in the changelog. | |
# We call 'feat' commits 'New Features' | |
change_type_map: | |
build: Build | |
docs: Documentation | |
feat: New Features | |
fix: Bug Fixes | |
perf: Performance Improvements | |
refactor: Refactoring | |
style: Stylistic Changes | |
ci: CI/CD | |
test: Testing | |
# The order of commit types in the changelog... | |
change_type_order: | |
- "feat" | |
- "fix" | |
- "perf" | |
- "refactor" | |
- "style" | |
- "test" | |
- "build" | |
- "ci" | |
- "docs" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment