Add a "how to release?" section to the README
authorPhilippe Pepiot <philippe.pepiot@logilab.fr>
Fri, 24 Jan 2020 14:58:02 +0100
changeset 886 f4b6386e6f35
parent 885 6db0f3b97ff8
child 887 b40bf41d380f
Add a "how to release?" section to the README Explain release process with pypi and wheels.
README
--- a/README	Fri Jan 24 14:57:14 2020 +0100
+++ b/README	Fri Jan 24 14:58:02 2020 +0100
@@ -16,11 +16,33 @@
 
 Documentation is available at https://rql.readthedocs.io
 
-BUILD
------
+HOW TO RELEASE?
+---------------
+
+Bump version number in __pkginfo__.py, then update the debian changelog with::
+
+	dch -v <version>-1 -D unstable
+
+Commit with ``hg commit -m "[pkg] Version <version>"`` and tag with ``hg tag
+<version> debian/<version>-1``.
+
+Ensure you have a clean working directory before upload to pypi by running
+``hg clean --all --dirs --files`` (warning: this will remove all untracked
+files).
+
+Generate the source distribution with ``python3 setup.py sdist``.
+
+rql has a faster implementation using libgecode. To make this available to
+users using pip and not having libgecode installed, we publish manylinux
+wheels to pypi.
 
 To build a manylinux package for rql we use quay.io/pypa/manylinux1_x86_64
 docker image and a custom script `build_wheel.sh` so you just have to execute
-it and it will pull docker image and execute script in this imageĀ :
+it and it will pull docker image and execute script in this imageĀ ::
 
-  sh build_wheel.sh
+	docker pull quay.io/pypa/manylinux1_x86_64
+	./build_wheel.sh
+
+Then upload source dist and wheels to pypi using twine::
+
+	twine upload dist/*.tar.gz dist/*.whl