-
-
Notifications
You must be signed in to change notification settings - Fork 301
feat: allow files-only to set config version and create changelog #299
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
feat: allow files-only to set config version and create changelog #299
Conversation
Codecov Report
@@ Coverage Diff @@ ## master #299 +/- ## ======================================= Coverage 96.96% 96.96% ======================================= Files 33 33 Lines 924 924 ======================================= Hits 896 896 Misses 28 28
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
First, thanks for contributing, highly appreciated! I think this is a breaking change. I'll take a look tomorrow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution! It looks good to me. Could you please modify this test case to test this functionality?
@Lee-W done!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution! It looks good to me. @woile Could you please check again?
Hey sorry for taking too long. I'm trying to find the original use case for files-only.
I recall it was to be able to generate the changelog with a different tool before doing the actual bump, there was like a chicken and egg situation, so this feature was introduced.
I hope my lack of memory doesn't break the intention of this feature, but I think this PR can be merged.
Just so my mistake doesn't happen again, I'll ask you to add documentation about this flag: use case and examples 😅
@woile Added a simple explanation for the --files-only. The only use case it makes sense it's to avoid creating the commit and tag, which is how I use it. Let me know if you think we could add more details.
In time, thanks for maintaining this project!
Let's merge it 🎉
Uh oh!
There was an error while loading. Please reload this page.
Description
This PR allows the command
bumpwith the flag--files-onlyto update the version in the configuration file and to create the changelog if the flag was passed.The current behavior exits the program before those 2 actions happen.
Checklist
./script/formatand./script/testlocally to ensure this change passes linter check and testExpected behavior
The version in the configuration file will be updated and the changelog will be created (if flag passed) when using
bump --files-only, changing the current behavior.Steps to Test This Pull Request
cz bump --files-only --changelogpyproject.tomlor.cz.toml.Additional context
Related issue: #298