Skip to content

refactor(bump): cleanup related to update_version_file#1594

Merged
Lee-W merged 3 commits intocommitizen-tools:v4-9-2from
bearomorphism:fix-regex
Nov 8, 2025
Merged

refactor(bump): cleanup related to update_version_file#1594
Lee-W merged 3 commits intocommitizen-tools:v4-9-2from
bearomorphism:fix-regex

Conversation

@bearomorphism
Copy link
Copy Markdown
Collaborator

@bearomorphism bearomorphism commented Sep 11, 2025

Description

Try to address confusing variable names and function names, also reduced the number of function parameters for better readability.

Relate #1580

Better test coverage for update_version_in_file:

  • Covered return value
  • Covered check_consistency=True
  • Covered other encoding values

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants