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

[marcusalstrom]

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

[codecov]

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]

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

[Lee-W]

let's make it a property

[Lee-W]

maybe renamed as version_files would be better?

[Lee-W]

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

[noirbizarre]

No unexpected extra file in release, I like this idea too, but it should include the changelog too if the option is set.

If it was possible to bump a dirty working copy, this is obviously a breaking change, and we should provide a way around this. Maybe a setting and param --allow-changed-files as version files are parsed for version and updated and some may have a process in which they stage their change to be taken in the bump without wanting version updated in this file