1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
|
==========================
aafigure maintainer docs
==========================
This document contains notes for developers and packagers. End users probably
want to read README.txt and the files in the documentation directory instead.
What's in the branch
====================
aafigure
This is the main part. The ``aafigure`` directory contains the python
package. The setup.py and other files in the root directory belong to it.
docutils-aafigure
This is a plugin for docutils, that provides a ``aafigure`` directive.
It is maintained in the ``docutils`` directory.
Debian Package
==============
The Debian package currently covers the aafigure package only. It is built
using bzr-builddeb (this ensures that only files under version control get
included in the source.tar.gz and no other files possibly present in the
working copy).
For a release:
1. Make sure the branch is up-to date.
2. Ensure the version is incremented:
- ``setup.py`` must be updated
- ``aafigure/aafigure.py`` must be updated, see version at end of file
- ``CHANGES.txt`` must contain a summary of the changes
- ``debian/changes`` must be updated (may use ``dch -v 0.3``)
- ``documentation/conf.py`` must be updated (version)
3. Make sure all changes are committed, including the version number changes.
4. Check the documentation, ``cd docuementation; make html``
Then see ``_build/html/index.html``.
5. Tag the sources ``bzr tag aafigure_0.3``.
6. Build a source package: ``bzr builddeb -S``.
7. Upload to PPA: ``dput aafigure-ppa ./aafigure_0.2_source.changes``.
8. Wait... Then check https://launchpad.net/~aafigure-team/+archive/ppa
9. Don't forget to ``bzr push``.
10. PyPi release done?
For a local test, ``debuild`` respectively ``debuild -S`` can be run in the
``aafigure`` directory. The resulting Debian package is placed in the parent
directory.
PyPi Release
============
See Debian package release and ensure that version numbers are correct.
1. ``python setup.py register``
2. ``python setup.py sdist upload``
Upload to packages.python.org:
1. ``cd documentation; make html zip``
2. go to http://pypi.python.org/pypi?%3Aaction=pkg_edit&name=aafigure and
upload the zip
dput settings
=============
The ``dput`` tool needs a configuration file: ``~/.dput.cf``::
[DEFAULT]
default_host_main = notspecified
[notspecified]
fqdn = SPECIFY.A.PPA.NAME
incoming = .
[aafigure-ppa]
fqdn = ppa.launchpad.net
method = ftp
incoming = ~aafigure-team/ppa/ubuntu/
login = anonymous
allow_unsigned_uploads = 0
References
==========
- bzr-builddeb Homepage: https://launchpad.net/bzr-builddeb
- bzr-builddeb Documentation: http://jameswestby.net/bzr/builddeb
|