Skip to content

Commit

Permalink
Add versioning (#67)
Browse files Browse the repository at this point in the history
* Change versioning to devcommit

fix off-by-one

use variable for patch version

fix version script to use total commits since last version change

bump version

use the thing we were already using

how did you get in there

* add versioning info to readme

* fix versioning commands

* add push flag to version commands
  • Loading branch information
patricksanders authored Apr 10, 2020
1 parent 021fc83 commit 88afe84
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ env_install: env/bin/activate
pip install -e default_plugins ;\
pip install -r requirements.txt ;\
pip install -r requirements-test.txt ;\
python setup.py develop
pip install -e .

.PHONY: install
install: clean
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,28 @@ make up-reqs
`PKG_CONFIG_PATH="/usr/local/opt/libxml2/lib/pkgconfig" make up-reqs` which forces pkgconfig to use
brew's xmlsec instead of the MacOS xmlsec (Details: https://github.com/mehcode/python-xmlsec/issues/111)

### Releases and Versioning

ConsoleMe uses [setupmeta](https://github.com/zsimic/setupmeta) for versioning, utilizing the [`devcommit` strategy](https://github.com/zsimic/setupmeta/blob/master/docs/versioning.rst#devcommit). This project adheres to [SemVer standards](https://semver.org/#summary) for major, minor, and patch versions. `setupmeta` diverges from SemVer slightly for development versions.

When you're ready to release **patch** changes on `master`:

```bash
python setup.py version --bump minor --commit --push
```

When you're ready to release **minor** changes on `master`:

```bash
python setup.py version --bump minor --commit --push
```

When you're ready to release **major** changes on `master` (rare, reserved for breaking changes):

```bash
python setup.py version --bump major --commit --push
```

### Running async functions

To run an async python function syncronously in a shell for testing:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ def run(self):
entry_points={},
cmdclass={"cleanall": CleanAllCommand},
include_package_data=True,
versioning="build-id",
versioning="devcommit",
zip_safe=False,
)

0 comments on commit 88afe84

Please sign in to comment.