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

Recommendation: Use git tags and GitHub releases to support software versioning #13

Open
pkmitre opened this issue Jan 16, 2019 · 0 comments

Comments

@pkmitre
Copy link

pkmitre commented Jan 16, 2019

The current approach used for versioning of the openVA software and associated algorithms appears to be to create gzipped tarballs and committing them to the master branch in GitHub. Git repositories support the use of tags for versioning, which is recommended over keeping historical releases on the HEAD of the master branch. Specifically, the next version of openVA could be released using git tags by

  1. Creating a tag with the appropriate name:

    git tag openVA_1.0.8

  2. Pushing the tag up to GitHub:

    git push origin --tags

Once tags are pushed to GitHub, the site allows any tagged version to be downloaded as either a zip file or a gzipped tarball via the "releases" link; for the openVA repository that link takes one to (https://github.com/verbal-autopsy-software/openVA/releases).

For more information on tagging, see (https://git-scm.com/book/en/v2/Git-Basics-Tagging).

GitHub also supports creating a "release" from a tag; a release supports additional features over tags like the ability to include release notes.

For more information on releases, see (https://help.github.com/articles/creating-releases/).

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

No branches or pull requests

1 participant