-
-
Notifications
You must be signed in to change notification settings - Fork 281
fix(changelog): handle custom tag_format in changelog generation #995
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
13116d5
fix(changelog): handle custom tag_format in changelog generation
grahamhar 1d493aa
test(changelog): handle custom tag_format in changelog generation
grahamhar 2e1c553
fix(changelog): Handle tag format without version pattern
grahamhar 97eb90c
fix(changelog): Factorized TAG_FORMAT_REGEXES
grahamhar e8fa7a2
docs(bump): Document the use of tag_format variables with curly brackets
grahamhar 3d65861
refactor: Use format strings
grahamhar 29d6223
Merge branch 'master' into regex-tags
woile File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Configuring commitizen in a monorepo | ||
|
||
This tutorial assumes the monorepo layout is designed with multiple components that can be released independently of each | ||
other, it also assumes that conventional commits with scopes are in use. Some suggested layouts: | ||
|
||
``` | ||
. | ||
├── library-b | ||
│ └── .cz.toml | ||
└── library-z | ||
└── .cz.toml | ||
``` | ||
|
||
``` | ||
src | ||
├── library-b | ||
│ └── .cz.toml | ||
└── library-z | ||
└── .cz.toml | ||
``` | ||
|
||
Each component will have its own changelog, commits will need to use scopes so only relevant commits are included in the | ||
woile marked this conversation as resolved.
Show resolved
Hide resolved
|
||
appropriate change log for a given component. Example config and commit for `library-b` | ||
|
||
```toml | ||
[tool.commitizen] | ||
name = "cz_customize" | ||
version = "0.0.0" | ||
tag_format = "${version}-library-b" # the component name can be a prefix or suffix with or without a separator | ||
update_changelog_on_bump = true | ||
|
||
[tool.commitizen.customize] | ||
changelog_pattern = "^(feat|fix)\\(library-b\\)(!)?:" #the pattern on types can be a wild card or any types you wish to include | ||
``` | ||
|
||
example commit message for the above | ||
|
||
`fix:(library-b) Some awesome message` | ||
|
||
If the above is followed and the `cz bump --changelog` is run in the directory containing the component the changelog | ||
should be generated in the same directory with only commits scoped to the component. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.