refactor(BaseFormat): merge ChangelogFormat into BaseFormat #1612
Conversation
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
bearomorphism
requested review from
Lee-W,
noirbizarre and
woile
as code owners
bearomorphism
commented
Sep 16, 2025
Comment on lines
+94
to
+99
|
|
||
| def parse_version_from_title(self, line: str) -> VersionTag | None: | ||
| raise NotImplementedError("parse_version_from_title is not implemented") | ||
|
|
||
| def parse_title_level(self, line: str) -> int | None: | ||
| raise NotImplementedError("parse_title_level is not implemented") |
Contributor
Author
There was a problem hiding this comment.
Not sure if we're going to implement these.
Contributor
Author
There was a problem hiding this comment.
I think not. Those methods look like protected and is only used in get_metadata_from_file but this class overrides the function get_metadata_from_file
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v4-9-2 #1612 +/- ##
=========================================
Coverage ? 98.29%
=========================================
Files ? 58
Lines ? 2695
Branches ? 0
=========================================
Hits ? 2649
Misses ? 46
Partials ? 0
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:
|
Member
|
I think @noirbizarre might be a better person to take a look at this one. My guts feeling tells me |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
BaseFormatalready looks like a base class for changelog format, but it has a parent class protocolChangelogFormat. It is confusing to me.Additionally, the protocol
ChangelogFormatdeclares implementations of methods. I consider it confusing too.This change addresses the unnecessary complexity and remove
ChangelogFormatcompletely from the codebase. The alternative now isBaseFormat.I am not sure if this is a breaking change. Please help to review.