search

brighthive / master-client-index

BrightHive's Master Client Index framework.
MIT License
2 stars 2 forks source link

Tag current version of codebase #8

Closed reginafcompton closed 5 years ago

reginafcompton commented 5 years ago

We're at 1.0.0! Let's tag the repo accordingly.

N.b., we do not need to version the API, just the codebase, even though we do have a repo structure in place to support this.

reginafcompton commented 5 years ago

Versioning codebases with tags

Tags, tags, tags. BrightHive versions the MCI codebase using annotated Git tags. Annotated tags point to a particular commit, and also come with a checksum, the name and email of the tagger, the date, and a tagging message.

How to view a tag. View all tags under the releases endpoint in the Github project, e.g., https://github.com/brighthive/master-client-index/releases. Or view the complete detail view, e.g., https://github.com/brighthive/master-client-index/releases/tag/v1.0.0

How to create a tag. Use your terminal and the Git CLI tool, and do the following:

# Pull recent changes from master
git co master
git pull origin master

# Create the tag with a message
git tag -a v1.0.0 -m "First version of MCI codebase (deployed in CO and VA)"

# Does it look right?
git show v1.0.0

# Push it
git push origin v1.0.0

Finally (if needed) use the Github UI to add a more robust description of the release: visit the release detail view, and click on "Edit."

reginafcompton commented 5 years ago

Closed via https://github.com/brighthive/master-client-index/releases/tag/v1.0.0