HACKING.mdwn

bup-cron maintenance instructions

This document describes various aspects of the maintenance of this software project. For usage instructions, see the README file.

Release checklist

• make sure tests pass: ./t/test-bup-cron.sh
• update the __version_info__ field in bup_cron/__init__.py
• update the CHANGELOG with git changelog (from git-extras)
• commit everything: git commit -a -m'prepare release x.y' -S
• lay down the git tag: git tag -s x.y
• make a tarball: ./setup.py sdist
• sign it: ls dist/*.{egg,tar.gz} | xargs gpg --detach-sign -a
• upload it to PyPI: twine upload dist/bup_cron-x.y*

Packaging

bup-cron is hooked into distutils and is published on PyPI. To operate those releases, you will need pip and twine to make uploads:

sudo apt-get install pip twine

... or follow the instructions in the pip install documentation then:

pip install twine

You will also need a registered account on pip with access to the bup-cron project.

Testing instructions

To run the tests, you'll need a copy of the bup source because we are using the bup test suite, for historical reasons (we wanted to be in core originally).

Simply get a copy of the bup source and uncompress it in the parent directory (../bup). The test suite also assumes the bup is in the path and is at least at version 0.26.

The tests are in the t/ directory.