Enhance the functionality of the bump_version.sh script
#169
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The token is optionally used for the build and prerelease actions to override the default values used by the semver Python package.
Since the replacement and commit of version change information is almost identical across the different logic flows it makes sense to DRY out the code.
Only retrieve the existing version information if the input to the bump_version.sh script isn't immediately invalid (if the script does not get 1-2 arguments).
mcdonnnj
added
the
improvement
mcdonnnj
requested review from
dav3r,
felddy,
jasonodoom and
jsf9k
as code owners
dav3r
reviewed
Aug 14, 2023
jsf9k
approved these changes
Aug 15, 2023
The team has come to the consensus that the `git push` should be at the discretion of the user. This both prevents needless GitHub Actions runs and ensures that the repository is updated when the user feels it is in an appropriate state. Co-authored-by: Shane Frasier <[email protected]>
jasonodoom
approved these changes
Aug 15, 2023
mcdonnnj
added
the
kraken 🐙
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
This pull request adds some functionality to the
bump_version.shscript and DRYs out some of the logic.Note
If/when this pull request is approved I plan on porting the changes over to other skeletons that have a
bump_version.shscript.💭 Motivation and context
I have used custom tokens for prerelease versions in some of my projects (
devinstead ofrcas an example) to better articulate what the version represents. I thought about it and determined that building the functionality into the script would be useful. While I was making the changes to support custom tokens I realized it would also make sense to do some general cleanup of the script.🧪 Testing
Automated tests pass. I verified that the script works as expected both with and without custom tokens for
build/prereleaseactions. I also verified that other actions worked as expected.✅ Pre-approval checklist