-
Notifications
You must be signed in to change notification settings - Fork 10
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
Add Scripts for Bumping Versions and Tagging #31
Add Scripts for Bumping Versions and Tagging #31
Conversation
…g through scripts. Update setup.py to include the semver package which is used by the bump_version.sh script.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small change requested.
…ments-dev.txt file to better match intent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ad astra!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved, but I request that you add one comment.
echo Changing version from "$old_version" to "$new_version" | ||
tmp_file=/tmp/version.$$ | ||
sed "s/$old_version/$new_version/" $VERSION_FILE > $tmp_file | ||
mv $tmp_file $VERSION_FILE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since it may come up in the future and so we don't forget our past, we should probably add a brief comment here about why we do this business with the temp file (short version: Mac OS uses BSD sed
- see cisagov/cyhy-mailer@283dcbf)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point. I've added comments in 03278ca to explain.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Good idea adding this functionality.
…sion in the bump_version.sh script.
Cleanup Linux instructions and add WSL references to CONTRIBUTING.md
🗣 Description
This PR adds the
bump_version.sh
andtag.sh
scripts to allow easy version bumping and tagging for Python projects. Thesemver
package was also added as a requirement since it is used bybump_version.sh
.💭 Motivation and Context
Versions and tags are used for marking a release point, and these helper scripts are already in use to that end in some Python projects we have. I thought it would be useful to add it to
skeleton-python-library
so that all Python projects will be able to leverage that functionality.🧪 Testing
Verified that the version was correctly retrieved with
bump_version.sh show
. Since these scripts are in use in other projects I assume other functionality will work correctly.🚥 Types of Changes
✅ Checklist