diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2017-06-01 11:09:08 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2017-06-01 11:09:08 -0400 |
| commit | 1b6d0c8088123a5bb8adaeda567fd58834f58e24 (patch) | |
| tree | a7b7e6152964380749d174dec322e3dea26e85ab /docs | |
| parent | f69469b16da3ab755ca9719a5e800b27aea80f62 (diff) | |
| download | external_python_setuptools-1b6d0c8088123a5bb8adaeda567fd58834f58e24.tar.gz external_python_setuptools-1b6d0c8088123a5bb8adaeda567fd58834f58e24.tar.bz2 external_python_setuptools-1b6d0c8088123a5bb8adaeda567fd58834f58e24.zip | |
Update release process to give guidance on updating the changelog prior to release.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/releases.txt | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/releases.txt b/docs/releases.txt index 5a0d0b01..da0e31f5 100644 --- a/docs/releases.txt +++ b/docs/releases.txt @@ -7,10 +7,20 @@ mechanical technique for releases, enacted by Travis following a successful build of a tagged release per `PyPI deployment <https://docs.travis-ci.com/user/deployment/pypi>`_. +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 ``bumpversion {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.5 tests). +the release will be uploaded to PyPI (from the Python 3.6 tests). Release Frequency ----------------- |