diff --git a/.bumpversion.cfg b/.bumpversion.cfg new file mode 100644 index 0000000..b34b790 --- /dev/null +++ b/.bumpversion.cfg @@ -0,0 +1,8 @@ +[bumpversion] +current_version = 0.1.1 +commit = True +tag = True +tag_name = v{new_version} +message = chore: bump version to {new_version} + +[bumpversion:file:VERSION] diff --git a/README.md b/README.md index b974c6f..6bbccd1 100644 --- a/README.md +++ b/README.md @@ -70,18 +70,35 @@ The install script symlinks everything safely into `$HOME`. --- +## 🔖 Versioning & Releases + +- Version number lives in the `VERSION` file and is managed by [bumpversion](https://github.com/c4urself/bump2version). +- Install the tool once (e.g. `pip install --user bump2version`). +- To cut a new release: + 1. Decide the part to bump (`patch`, `minor`, or `major`). + 2. Run `bumpversion ` which updates `VERSION`, commits, and tags using `.bumpversion.cfg`. + 3. Push everything: `git push && git push --tags`. + +--- + ## 📁 Structure ``` dotfiles/ -├── zsh/ -│ ├── .zshrc -│ └── custom/ +├── .bumpversion.cfg +├── .github/ +│ └── workflows/ +│ └── secret-scan.yml +├── .gitignore +├── .pre-commit-config.yaml +├── README.md +├── VERSION ├── git/ -│ ├── .gitconfig -│ └── .gitignore_global +│ ├── gitconfig +│ └── gitconfig_qustodio (optional) ├── install.sh -└── README.md +└── zsh/ + └── zshrc ``` --- diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..17e51c3 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +0.1.1