Commit 37978a70 authored by Jeremy Bowman's avatar Jeremy Bowman

Update release process docs

parent 50e3ba6e
Added ``tox`` environment for documentation builds.
Added coverage badge to README.
Made small fixes to the developer guide documentation.
Updated release process docs.
...@@ -7,20 +7,31 @@ mechanical technique for releases, enacted by Travis following a ...@@ -7,20 +7,31 @@ mechanical technique for releases, enacted by Travis following a
successful build of a tagged release per successful build of a tagged release per
`PyPI deployment <https://docs.travis-ci.com/user/deployment/pypi>`_. `PyPI deployment <https://docs.travis-ci.com/user/deployment/pypi>`_.
Prior to cutting a release, please check that the CHANGES.rst reflects Prior to cutting a release, please use `towncrier`_ to update
the summary of changes since the last release. ``CHANGES.rst`` to summarize the changes since the last release.
Ideally, these changelog entries would have been added To update the changelog:
along with the changes, but it's always good to check.
Think about it from the 1. Install towncrier via ``pip install towncrier`` if not already installed.
perspective of a user not involved with the development--what would 2. Preview the new ``CHANGES.rst`` entry by running
that person want to know about what has changed--or from the ``towncrier --draft --version {new.version.number}`` (enter the desired
perspective of your future self wanting to know when a particular version number for the next release). If any changes are needed, make
change landed. them and generate a new preview until the output is acceptable. Run
``git add`` for any modified files.
To cut a release, install and run ``bump2version {part}`` where ``part`` 3. Run ``towncrier --version {new.version.number}`` to stage the changelog
updates in git.
Once the changelog edits are staged and ready to commit, cut a release by
installing and running ``bump2version {part}`` where ``part``
is major, minor, or patch based on the scope of the changes in the is major, minor, or patch based on the scope of the changes in the
release. Then, push the commits to the master branch. If tests pass, release. Then, push the commits to the master branch::
the release will be uploaded to PyPI (from the Python 3.6 tests).
$ git push origin master
$ git push --tags
If tests pass, the release will be uploaded to PyPI (from the Python 3.6
tests).
.. _towncrier: https://pypi.org/project/towncrier/
Release Frequency Release Frequency
----------------- -----------------
......
...@@ -8,7 +8,6 @@ ...@@ -8,7 +8,6 @@
{% for text, values in sections[section][category].items() %} {% for text, values in sections[section][category].items() %}
* {{ values|join(', ') }}: {{ text }} * {{ values|join(', ') }}: {{ text }}
{% endfor %} {% endfor %}
{% else %} {% else %}
* {{ sections[section][category]['']|join(', ') }} * {{ sections[section][category]['']|join(', ') }}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment