Open Source Exanalytics
This howto documents wendelin.core release procedure. It also applies to other Python software, for example to zodbtools and pygolang.
© 2019  Nexedi
Kirill Smelkov, Jérome Perrin, Sven Franck  |

Wendelin.core - Release howto

Wendelin.core - Release howto

=============================== Wendelin.core - Release Howto===============================:author: Kirill Smelkov :date: 2015 June 16:last-updated-for: wendelin.core v0.3:abstract: This document describes steps needed to make a new release of `wendelin.core`__ __ https://lab.nexedi.com/nexedi/wendelin.coreMake worktree clean===================Either1. make sure your working tree is clean:: $ git clean -fdX $ git submodule foreach git clean -fdX or2. clone `wendelin.core` afresh:: $ git clone --recursive https://lab.nexedi.com/nexedi/wendelin.core $ cd wendelin.coreIncrease version & describe changes===================================1. Increment version in `setup.py` .2. Describe what has been changed in this release in `CHANGES`.Make sure it works==================Run set-up `tox`__ tests. This will test whether wendelin.core builds ok withvarious python versions and various `ZODB`__ versions:: $ toxtail of output should be something like:: ... ________ summary ________ py27-ZODB3: commands succeeded py27-ZODB4: commands succeeded py34-ZODB4: commands succeeded congratulations :)__ https://tox.readthedocs.org__ http://www.zodb.org.. note:: if you experience failures, while running tox, e.g. code crashes saying zodbpickle module is not found, before running tests, make sure your tox/virtualenv is uptodate. e.g. on Debian system:: $ virtualenv venv-4release $ . venv-4release/bin/activate $ pip install tox $ hash -rMake release commit===================1. Ensure to stage changes in `setup.py` and `CHANGES` for commit. E.g. with:: $ git add -p ( interactively select changes to commit )2. Ensure all changes were staged and there will be no other changes in worktree after commit:: $ git status ( should be absent or empty section "Changes not staged for commit:" )3. Make release commit:: $ git commit -S -m "wendelin.core vX.y"4. Make release tag:: $ git tag -s -m "wendelin.core vX.y" vX.y.. note:: The commit and tag are made gpg-signed (the `-S` and `-s` options)Prepare release tarball=======================:: $ python setup.py sdistthis should create `dist/wendelin.core-X.y.tar.gz` .Check restructured text syntax==============================:: $ twine check dist/*this checks that the syntax of the long description is written in a syntaxicallycorrect restructured text and will render properly on pypi.It's also a good idea to use a spellchecker to detect English mistakes.Test release tarball====================Unpack intended-to-release tarball somewhere and test it again with tox:: $ mkdir tmp $ cd tmp $ tar xfz ../dist/wendelin.core-X.y.tar.gz $ cd wendelin.core-X.y $ toxThe output should be again:: ... ________ summary ________ py27-ZODB3: commands succeeded py27-ZODB4: commands succeeded py34-ZODB4: commands succeeded congratulations :).. warning:: If **not**: 1. investigate what is wrong / what needs to be corrected. 2. remove release tag and commit:: $ git tag -d vX.y $ git reset HEAD~ # keeping made changes to setup.py & CHANGES 3. fix problems; go again to `Make release commit`_.Sign release tarball====================If release tarball was tested ok - sign it:: $ gpg --armor --detach-sign wendelin.core-X.y.tar.gzUpload to `PyPI`__==================After release tarball is ready and signed - upload it to PyPI:: $ twine upload -u wendelin.core-X.y.tar.gz*.. warning:: Do **not** use PyPI web UI to upload new release. The UI has bugs which will prevent uploading this release further even with `twine` or `setup.py upload`.after uploading, make sure that1. sha512sum shown on PyPI corresponds to real sha512sum of `dist/wendelin.core-X.y.tar.gz` .2. PGP signature shown on PyPI is the same as `dist/wendelin.core-X.y.tar.gz.asc` . Note that currently PyPI does not directly display the signature in the web interface, but it's possible to download the .asc by appending .asc to the tarball download URL .__ https://pypi.python.org/pypiPush release commit & tag to public git repo============================================:: $ git push origin master vX.yMake release announcement (optional for now)============================================Tell the world - send email about new release to corresponding mailing lists,`LWN.net`__, etc . Make announcements on twitter and facebook.__ http://lwn.net/

Thank You

  • Nexedi SA
  • 147 Rue du Ballon
  • 59110 La Madeleine
  • France
  • +33629024425

For more information, please contact Jean-Paul, CEO of Nexedi (+33 629 02 44 25).