summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <smcv@collabora.com>2019-09-02 15:47:51 +0100
committerSimon McVittie <smcv@collabora.com>2019-09-02 15:47:51 +0100
commite5fd30a70661075dcd81913f9ab8c134f45deb4f (patch)
tree19f044ff4661c7ae1b4ec473751133855138689f
parente6c02a03a5c2ef5df5893d7517ed3e109e860cd6 (diff)
downloaddbus-python-e5fd30a70661075dcd81913f9ab8c134f45deb4f.tar.gz
Document how to release dbus-python
Otherwise I'll probably forget a step, usually updating PyPI. Signed-off-by: Simon McVittie <smcv@collabora.com>
-rw-r--r--CONTRIBUTING.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f36ead0..75937a6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -163,6 +163,27 @@ so you should have an issue number or a merge request ID to refer to.
### Making a release
-The release process is not currently documented.
+#### Pre-release steps
-Remember to upload each new source release to PyPI.
+* Make sure CI (currently Travis-CI and Gitlab) is passing
+* Update `NEWS` and the version number in `configure.ac`, and commit them
+
+#### Building and uploading the release
+
+If `${builddir}` is the path to a build directory and `${version}`
+is the new version:
+
+```
+make -C ${builddir} distcheck
+# do any final testing here, e.g. updating the Debian package
+git tag -m dbus-python-${version} -s dbus-python-${version}
+gpg --detach-sign -a ${builddir}/dbus-python-${version}.tar.gz
+make -C ${builddir} maintainer-upload
+make -C ${builddir} maintainer-update-website
+twine upload ${builddir}/dbus-python-${version}.tar.gz{,.asc}
+```
+
+#### Post-release steps
+
+* Announce the new release to the D-Bus mailing list
+* Update `NEWS` and the version number in `configure.ac`, and commit them