From e5fd30a70661075dcd81913f9ab8c134f45deb4f Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Mon, 2 Sep 2019 15:47:51 +0100 Subject: Document how to release dbus-python Otherwise I'll probably forget a step, usually updating PyPI. Signed-off-by: Simon McVittie --- CONTRIBUTING.md | 25 +++++++++++++++++++++++-- 1 file 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 -- cgit v1.2.1