1 # Releasing datasette-connectors
3 Author: Javier Sancho, Francesc Alted
4 Contact: jsf@jsancho.org, francesc@blosc.org
10 * Update the version number at ``VERSION`` and ``ANNOUNCE.md``.
12 * Make sure that ``RELEASE_NOTES.md`` and ``ANNOUNCE.md`` are up to
13 date with the latest news in the release.
15 * Commit your changes:
18 $ git commit -a -m"Getting ready for X.Y.Z final"
21 * Once a year: check that the copyright year in `LICENSE` file.
26 * Create a tag ``vX.Y.Z`` from ``master``. Use the next message:
29 $ git tag -a vX.Y.Z -m "Tagging version X.Y.Z"
32 Note: For release candidates, just add a rcN suffix to tag ("vX.Y.ZrcN").
34 * Or, alternatively, make a signed tag (requires gpg correctly configured):
37 $ git tag -s vX.Y.Z -m "Tagging version X.Y.Z"
40 * Push the tag to the Github repo:
47 * Do the official release. Go to:
49 https://github.com/PyTables/datasette-connectors/releases/edit/vX.Y.Z
51 and add the title for the release (vX.Y.Z) and the release notes there.
56 * Go to the root directory and run:
65 * Make sure that you are in a clean directory. The best way is to
66 re-clone and re-build:
70 $ git clone https://github.com/PyTables/datasette-connectors
71 $ cd datasette-connectors
72 $ python setup.py build
76 * Make the tarball with the command:
79 $ python setup.py sdist
82 Do a quick check that the tarball is sane.
87 * Upload it also in the PyPi repository:
90 $ python setup.py sdist upload
96 * Send an announcement to the pytables-announce, pytables-users and pydata
97 lists. Use the ``ANNOUNCE.md`` file as skeleton (or possibly as
98 the definitive version).
100 * Tweet about the new release and rejoice!
103 ## Post-release actions
105 * Create new headers for adding new features in ``RELEASE_NOTES.rst``
106 and add this place-holder instead:
108 #XXX version-specific blurb XXX#
110 * Update ``VERSION`` file to X.Y.(Z+1)-dev
112 * Commit your changes with:
115 $ git commit -a -m"Post X.Y.Z release actions done"