Commit 45acd729 authored by Christophe Benz's avatar Christophe Benz

Add Release section to README

parent d3a4ee3a
Pipeline #87239 passed with stage
in 35 seconds
......@@ -66,3 +66,15 @@ pytest
# Specify an alterate API URL
API_URL=http://localhost:5000 pytest
```
## Release
To release a version on PyPI:
- merge one or many feature branches into master (no need to do a release for every feature...)
- update `setup.py` incrementing the package version (we use Semantic Versioning so determine if it's a major, minor or patch increment)
- ensure the changelog is up to date
- `git commit setup.py CHANGELOG.md -m "Release"`
- create a Git tag with a `v` before version number and push it (`git tag v1.2.0; git push; git push --tags`)
- the [CI](./.gitlab-ci.yml) will run a job to publish the package on PyPI at https://pypi.org/project/DBnomics/
It's advised to do `pip install -e .` to let your virtualenv know about the new version number.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment