Gitflux is an all in one conventional commit management and tag version manager.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Gitflux is a work in progress proof of concept to further deepen my understanding of Rust, This tool is not intended for production usecases yet, but might be in the future. Please use at your own risk.
A lot of this README is still WIP so forgive any boilerplate still left over, thanks very much to othneildrew and his awesome readme template!
Gitflux provides full incremental management of your tags in your repo using simple semver formatting, any git tags that cannot be parsed to a simple semver format will be ignored. You can initialise a simple tag pointing to the HEAD of your repository using
gitflux bump --initYou can also increase logging level by parsing the -v flag, this can be used incrementally to increase the logging level, each 'v' representing a greater level of logging, for example:
gitflux bump --init -vvvvThis will provide the highest level of verbosity (information).
Once you have initialised a semver tag, you can simply bump the patch level using
gitflux bumpYou can also pass the --tag-schema major|minor|patch or -t major|minor|patch flags to override the tag version that gitflux will bump your tag by:
gitflux bump --tag-schma minorFor more examples, please refer to the Documentation
- Get tag bumping functionality up and running.
- Create development branch
- Tag releases from dev branch to master with gitflux
- Configure global settings serde parsing.
- CI/CD building for releases.
- Lock step tag version with build / release version? Rust is doable, other apps maybe?
- Implement conventional commit message manager and commit handling
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU GENERAL PUBLIC LICENSE. See LICENSE for more information.
Project Link: https://github.com/nrexception/gitflux