Skip to content
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

fix(bump)!: only add version files and staged changes #1261

Open
wants to merge 4 commits into
base: v4
Choose a base branch
from

Conversation

marcusalstrom
Copy link

Description

Bump will now only add and commit version files along with any already committed changes. Any unstaged changes will remain unstaged.

NOTE: BREAKING CHANGE, since we added a new abstract method to VersionProvider any custom version provider will break. (open to any suggestions on how to avoid this)

Checklist

  • Add test cases to all the changes you introduce
  • Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

Only version files and already staged changes will be committed on bump.

Steps to Test This Pull Request

  1. cz bump with unstaged changes
  2. only version files (and any staged changes) will be added and committed, unstaged changes will remain unstaged

Additional context

References issue #1194

Copy link

codecov bot commented Oct 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (v4@eafcef6). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff          @@
##             v4    #1261   +/-   ##
=====================================
  Coverage      ?   97.64%           
=====================================
  Files         ?       55           
  Lines         ?     2594           
  Branches      ?        0           
=====================================
  Hits          ?     2533           
  Misses        ?       61           
  Partials      ?        0           
Flag Coverage Δ
unittests 97.64% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Lee-W Lee-W changed the base branch from master to v4 November 10, 2024 02:39
@Lee-W
Copy link
Member

Lee-W commented Nov 10, 2024

As this is breaking change, I change the base branch to v4

@@ -34,6 +34,12 @@ def set_version(self, version: str):
Set the new current version
"""

@abstractmethod
def get_files(self) -> list[str]:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make it a property

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe renamed as version_files would be better?

@Lee-W
Copy link
Member

Lee-W commented Nov 10, 2024

In general, I like this idea. @woile @noirbizarre would love to know your thought 🙂

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