Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.03 KB

README.md

File metadata and controls

67 lines (49 loc) · 2.03 KB
Raw

tag-flow

This script is intended to continuosly create tags according to the semantic versioning specs in the current head of a git repo. This script only increments the PATCH of the previously tagged version, to increment the MAJOR or MINOR number it is necessary to manually create a tag or use one of the arguments.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisities

Python 2.7+

Installing

  • Tag the first representative commit of your repo to start the "flow" (e.g. v1.0.0, or 0.5.2)
  • Copy tag.py in your project or add it as a submodule:
git submodule add git@github.com:bq/tag-flow.git

IMPORTANT: if you use a CI system, make sure your CI user can pull from Github, else use

git submodule add https://github.com/bq/tag-flow.git
  • Inside the repo, use one of these:
python tag-flow/tag.py
python tag-flow/tag.py bump-minor
python tag-flow/tag.py bump-major

Samples

Increment patch

# python tag-flow/tag.py
Creating new tag: v1.0.45 (previous tag for branch: v1.0.44)

Increment minor

# python tag-flow/tag.py bump-minor
Creating new tag: v1.1.0 (previous tag for branch: v1.0.44)

Increment major

# python tag-flow/tag.py bump-major
Creating new tag: v2.0.0 (previous tag for branch: v1.0.44)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Acknowledgements

The work in this repository up to April 28th, 2021 was done by bq. Thanks for all the work!!

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details