Skip to content

Commit ad42f09

Browse files
committed
Add release checklist
1 parent 8469f72 commit ad42f09

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,23 @@ To create the HTML pages, use::
3737
The generated files will be available in the directory ``build/sphinx/html/``.
3838

3939
.. _Sphinx: http://sphinx-doc.org/
40+
41+
New releases are made using the following steps:
42+
43+
#. Bump version number in ``sfs/__init__.py``
44+
#. Update ``NEWS.rst``
45+
#. Commit those changes as "Release x.y.z"
46+
#. Create an (annotated) tag with ``git tag -a x.y.z``
47+
#. Clear the ``dist/`` directory
48+
#. Create a source distribution with ``python3 setup.py sdist``
49+
#. Create a wheel distribution with ``python3 setup.py bdist_wheel --universal``
50+
#. Check that both files have the correct content
51+
#. Upload them to PyPI with twine_: ``twine upload dist/*``
52+
#. Push the commit and the tag to Github and `add release notes`_ containing a
53+
link to PyPI and the bullet points from ``NEWS.rst``
54+
#. Check that the new release was built correctly on RTD_, delete the "stable"
55+
version and select the new release as default version
56+
57+
.. _twine: https://pypi.python.org/pypi/twine
58+
.. _add release notes: https://github.com/sfstoolbox/sfs-python/tags
59+
.. _RTD: http://readthedocs.org/projects/sfs/builds/

0 commit comments

Comments
 (0)