Open
Description
Description
When running cz bump --changelog
from a folder other than git’s base then
- changelog is generated in whatever folder I’m currently in instead of finding the file in the base folder, and
- additional version_files aren’t updated at all because they’re not found.
There’s no warning or error that the additional version files weren’t found either.
If cz
runs under the assumption that cwd
should be the git base folder then that should be handled more gracefully, either using a warning or by finding the files correctly. As it is, running cz
from some folder deeper inside of the git repo yields an unexpected and incorrect bump commit.
Steps to reproduce
Change into any subfolder in a git repo, then run cz bump --changelog
.
Current behavior
- No warnings or errors.
- New CHANGELOG file in whichever subfolder I’m in, instead of amending the actual CHANGELOG.
- None of the files listed in version_files are found and updated.
Desired behavior
Update the actual CHANGELOG and bump files listed in version_files.
Screenshots
No response
Environment
Commitizen Version: 4.1.0
Python Version: 3.13.2 (main, Feb 8 2025, 23:18:32) [Clang 14.0.3 (clang-1403.0.22.14.1)]
Operating System: Darwin
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
Lee-W commentedon Mar 30, 2025
Hi @jenstroeger , thanks for reporting this. I just verify this with the following.
the CHANGELOG.md is generated in the
test
subdirectoy instead of the rootYusin0903 commentedon Apr 8, 2025
Hi @Lee-W, I have reproduced the bug.
Is the right way to place the CHANGELOG to the same directory as .cz.toml?
Lee-W commentedon Apr 9, 2025
Yep, I think so. 👀
Yusin0903 commentedon Apr 9, 2025
@Lee-W thanks for the response!
Can I try this issue? I can do with other issue.
Lee-W commentedon Apr 9, 2025
Sure! Thanks for helping out 🙂
jenstroeger commentedon Apr 13, 2025
@Lee-W yes, you reproduce this correctly. Basically, given my package repo and no matter what the current folder I’m in, I expect that running
cz
updates the “real” CHANGELOG file at the root of the package/repo.