diff --git a/changelog.d/1352.misc.rst b/changelog.d/1352.misc.rst new file mode 100644 index 0000000000..331ce47b2b --- /dev/null +++ b/changelog.d/1352.misc.rst @@ -0,0 +1 @@ +Added ``tox`` environment for documentation builds. diff --git a/changelog.d/1353.doc.rst b/changelog.d/1353.doc.rst new file mode 100644 index 0000000000..f23fec8f9c --- /dev/null +++ b/changelog.d/1353.doc.rst @@ -0,0 +1 @@ +Added coverage badge to README. diff --git a/changelog.d/1356.doc.rst b/changelog.d/1356.doc.rst new file mode 100644 index 0000000000..7ea0e8303e --- /dev/null +++ b/changelog.d/1356.doc.rst @@ -0,0 +1 @@ +Made small fixes to the developer guide documentation. diff --git a/changelog.d/1376.doc.rst b/changelog.d/1376.doc.rst new file mode 100644 index 0000000000..c2dcacdaab --- /dev/null +++ b/changelog.d/1376.doc.rst @@ -0,0 +1 @@ +Updated release process docs. diff --git a/docs/releases.txt b/docs/releases.txt index 30ea084fec..234f69eeb9 100644 --- a/docs/releases.txt +++ b/docs/releases.txt @@ -7,20 +7,31 @@ mechanical technique for releases, enacted by Travis following a successful build of a tagged release per `PyPI deployment `_. -Prior to cutting a release, please check that the CHANGES.rst reflects -the summary of changes since the last release. -Ideally, these changelog entries would have been added -along with the changes, but it's always good to check. -Think about it from the -perspective of a user not involved with the development--what would -that person want to know about what has changed--or from the -perspective of your future self wanting to know when a particular -change landed. - -To cut a release, install and run ``bump2version {part}`` where ``part`` +Prior to cutting a release, please use `towncrier`_ to update +``CHANGES.rst`` to summarize the changes since the last release. +To update the changelog: + +1. Install towncrier via ``pip install towncrier`` if not already installed. +2. Preview the new ``CHANGES.rst`` entry by running + ``towncrier --draft --version {new.version.number}`` (enter the desired + version number for the next release). If any changes are needed, make + them and generate a new preview until the output is acceptable. Run + ``git add`` for any modified files. +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 -release. Then, push the commits to the master branch. If tests pass, -the release will be uploaded to PyPI (from the Python 3.6 tests). +release. Then, push the commits to the master branch:: + + $ 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 ----------------- diff --git a/towncrier_template.rst b/towncrier_template.rst index 02b2882bb1..9c23b9775f 100644 --- a/towncrier_template.rst +++ b/towncrier_template.rst @@ -8,7 +8,6 @@ {% for text, values in sections[section][category].items() %} * {{ values|join(', ') }}: {{ text }} {% endfor %} - {% else %} * {{ sections[section][category]['']|join(', ') }}