Commit e74c482e authored by Paul Ganssle's avatar Paul Ganssle Committed by GitHub

Merge pull request #1379 from pypa/jmbowman/release_docs_fix

Make minor fixes to release docs
parents 6d07df75 341bbf4d
...@@ -5,6 +5,8 @@ v39.2.0 ...@@ -5,6 +5,8 @@ v39.2.0
a text file. a text file.
* #1360: Fixed issue with a mismatch between the name of the package and the * #1360: Fixed issue with a mismatch between the name of the package and the
name of the .dist-info file in wheel files 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 * #1365: Take the package_dir option into account when loading the version from
a module attribute. a module attribute.
* #1353: Added coverage badge to README. * #1353: Added coverage badge to README.
......
Add `__dir__()` implementation to `pkg_resources.Distribution()` that includes the attributes in the `_provider` instance variable.
\ No newline at end of file
Minor doc fixes after actually using the new release process.
...@@ -19,9 +19,13 @@ To update the changelog: ...@@ -19,9 +19,13 @@ To update the changelog:
``git add`` for any modified files. ``git add`` for any modified files.
3. Run ``towncrier --version {new.version.number}`` to stage the changelog 3. Run ``towncrier --version {new.version.number}`` to stage the changelog
updates in git. 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 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 is major, minor, or patch based on the scope of the changes in the
release. Then, push the commits to the master branch:: release. Then, push the commits to the master branch::
......
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