fix(1694): changelog_merge_prerelease not working on cz bump #1700
Conversation
…ntains only prereleases
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1700 +/- ##
==========================================
+ Coverage 97.33% 97.91% +0.57%
==========================================
Files 42 60 +18
Lines 2104 2642 +538
==========================================
+ Hits 2048 2587 +539
+ Misses 56 55 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| cli.main() | ||
|
|
||
| testargs = ["cz", "bump", "--changelog"] | ||
|
|
There was a problem hiding this comment.
nit: remove this blank line
| if during_version_bump and rules.merge_prereleases: | ||
| current_tag = None | ||
| else: | ||
| current_tag = get_commit_tag(commits[0], tags) if commits else None |
There was a problem hiding this comment.
| if during_version_bump and rules.merge_prereleases: | |
| current_tag = None | |
| else: | |
| current_tag = get_commit_tag(commits[0], tags) if commits else None | |
| if during_version_bump and rules.merge_prereleases and not commits: | |
| current_tag = None | |
| else: | |
| # Check if the latest commit is not tagged | |
| current_tag = get_commit_tag(commits[0], tags) |
| "incremental": True, | ||
| "dry_run": dry_run, | ||
| "during_version_bump": self.arguments["prerelease"] | ||
| is None, # We let the changelog implementation know that we want to replace prereleases while staying incremental AND the new tag does not exist already |
There was a problem hiding this comment.
The comment is a bit unclear to me.
| latest_version_index = index | ||
| line = line.strip().lower() | ||
|
|
||
| parsed = self.parse_version_from_title(line) |
There was a problem hiding this comment.
Could you rename the variable parsed to something more clear? Such as parsed_version. As well as the parsed in another function get_metadata_from_file.
Thanks!
| if parsed: | ||
| if not self.tag_rules.extract_version( | ||
| GitTag(parsed.tag, "", "") | ||
| ).is_prerelease: |
There was a problem hiding this comment.
Combine these if statements with and
| ) as changelog_file: | ||
| return self.get_latest_full_release_from_file(changelog_file) | ||
|
|
||
| def get_latest_full_release_from_file(self, file: IO[Any]) -> IncrementalMergeInfo: |
There was a problem hiding this comment.
Why extract this function? I don't see any benefits.
You could put the whole function body under with open block and the logic is still clear.
Description
This PR solves issue #1694.
Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and tests (Some error out on mac. I will investigate if they fail in ci)- [ ] Update the documentation for the changes(I do not think this applies. It works now as documented.)### Documentation Changes- [ ] Runpoetry doclocally to ensure the documentation pages renders correctly- [ ] Check and fix any broken links (internal or external) in the documentationExpected Behavior
See issue #1694.
Steps to Test This Pull Request
poetry build.Additional Context
Known issue: When the changelog only contains pre-releases, the old behavior can still be observed.(Fixed)