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

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

Additional context

References issue#1194

marcusalstrom added3 commits

October 15, 2024 11:04

fix(bump): only add version files

fd29f2a

BREAKING CHANGE: VersionProvider has new method which will break any custom version provider

test(bump): add tests for bumping only version files

9573f0b

docs(providers): add example implementation of new method for custom …

f6c1c66

…version providers

marcusalstrom requested review fromLee-W,noirbizarre andwoile ascode owners

October 15, 2024 09:53

github-actionsbot added the pr-status: wait-for-review label

Oct 15, 2024

Copy link

codecovbot commentedOct 15, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Pleaseupload report for BASE (v5@eafcef6).Learn more about missing BASE report.

Additional details and impacted files

@@          Coverage Diff          @@##             v5    #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.

marcusalstrom mentioned this pull request

Oct 15, 2024

Open-Source Contribution SubmissionKTH/devops-course#2662

Merged

style: remove commented code

cf91a07

Lee-W changed the base branch frommaster tov4

November 10, 2024 02:39

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 asversion_files would be better?

Lee-W added pr-status: wait-for-modification and removed pr-status: wait-for-review labels

Nov 10, 2024

Copy link

Member

Lee-W commentedNov 10, 2024

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

Copy link

Member

noirbizarre commentedNov 28, 2024

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 asversion 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