Make minor fixes to release docs

This commit is contained in:
Jeremy Bowman 2018-05-19 15:37:39 -04:00
parent 6d07df7536
commit 341bbf4d0a
4 changed files with 8 additions and 2 deletions

View File

@ -5,6 +5,8 @@ v39.2.0
a text file.
* #1360: Fixed issue with a mismatch between the name of the package and the
name of the .dist-info file in wheel files
* #1364: Add `__dir__()` implementation to `pkg_resources.Distribution()` that
includes the attributes in the `_provider` instance variable.
* #1365: Take the package_dir option into account when loading the version from
a module attribute.
* #1353: Added coverage badge to README.

View File

@ -1 +0,0 @@
Add `__dir__()` implementation to `pkg_resources.Distribution()` that includes the attributes in the `_provider` instance variable.

1
changelog.d/1379.doc.rst Normal file
View File

@ -0,0 +1 @@
Minor doc fixes after actually using the new release process.

View File

@ -19,9 +19,13 @@ To update the changelog:
``git add`` for any modified files.
3. Run ``towncrier --version {new.version.number}`` to stage the changelog
updates in git.
4. Verify that there are no remaining ``changelog.d/*.rst`` files. If a
file was named incorrectly, it may be ignored by towncrier.
5. Review the updated ``CHANGES.rst`` file. If any changes are needed,
make the edits and stage them via ``git add CHANGES.rst``.
Once the changelog edits are staged and ready to commit, cut a release by
installing and running ``bump2version {part}`` where ``part``
installing and running ``bump2version --allow-dirty {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::