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

Incremental versioning #260

Merged
merged 6 commits into from
Feb 22, 2022
Merged

Incremental versioning #260

merged 6 commits into from
Feb 22, 2022

Conversation

eeberhard
Copy link
Member

Here's a snazzy little script to make incremental versioning of our development patches easier.

I want all little features, fixes and patches in develop to have a respective patch number, so that we can keep track of changes more easily. But, changing the project version in all the right places is a bit cumbersome.

This script makes it really easy to update the version number at the end of a PR. Basically, once your feature is ready to go, you can do ./update_version.sh --commit and it will automatically increment the patch number in all the files and generate a commit for you.

See the help text for the other options. At a future point we can get the CI to do this for us, but for now let's try it out manually.

I wouldn't mind this being the first PR after the 5.0.0 release, to set the foundation nicely, after which the other pending PRs can close.

* Require contributors to update the version number with each PR
* Contain the current project version in a VERSION text file,
for internal and possible external convenience
* Add script to make updating the project version across all
relevant files easy
domire8
domire8 previously approved these changes Feb 21, 2022
Copy link
Contributor

@domire8 domire8 left a comment

Choose a reason for hiding this comment

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

Love it, that should definitely be the first PR after the release

buschbapti
buschbapti previously approved these changes Feb 22, 2022
Copy link
Contributor

@buschbapti buschbapti left a comment

Choose a reason for hiding this comment

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

This is super handy and should be in all our repos. Grat job!

* Handle the difference in `sed` argument parsing between
Mac and Linux using if / else case

* Remove dependency on `bc` calculator tool and use bash
arithmetic expansion expressions instead
@eeberhard eeberhard dismissed stale reviews from buschbapti and domire8 via cbf3ec3 February 22, 2022 09:43
@eeberhard
Copy link
Member Author

I decided it would be a nice idea to make sure that this works on linux too, since the sed argument syntax is a little different. Should be all good now :)

@eeberhard eeberhard merged commit cec9af6 into develop Feb 22, 2022
@domire8 domire8 deleted the feature/versioning branch February 24, 2022 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants