aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Ganssle <pganssle@users.noreply.github.com>2018-05-19 16:04:43 -0400
committerGitHub <noreply@github.com>2018-05-19 16:04:43 -0400
commite74c482e19518d05c226826c00625da41af1a12b (patch)
tree170ca1b048f3835738240162bcb5c05ff52a39e1
parent6d07df7536d3799fafa2877f1b02ccfc0378658c (diff)
parent341bbf4d0a8a6674255517a5145aecf7e3957c15 (diff)
downloadexternal_python_setuptools-e74c482e19518d05c226826c00625da41af1a12b.tar.gz
external_python_setuptools-e74c482e19518d05c226826c00625da41af1a12b.tar.bz2
external_python_setuptools-e74c482e19518d05c226826c00625da41af1a12b.zip
Merge pull request #1379 from pypa/jmbowman/release_docs_fix
Make minor fixes to release docs
-rw-r--r--CHANGES.rst2
-rw-r--r--changelog.d/1364.rst1
-rw-r--r--changelog.d/1379.doc.rst1
-rw-r--r--docs/releases.txt6
4 files changed, 8 insertions, 2 deletions
diff --git a/CHANGES.rst b/CHANGES.rst
index d3d661cc..156ba47d 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -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.
diff --git a/changelog.d/1364.rst b/changelog.d/1364.rst
deleted file mode 100644
index f7b4c012..00000000
--- a/changelog.d/1364.rst
+++ /dev/null
@@ -1 +0,0 @@
-Add `__dir__()` implementation to `pkg_resources.Distribution()` that includes the attributes in the `_provider` instance variable. \ No newline at end of file
diff --git a/changelog.d/1379.doc.rst b/changelog.d/1379.doc.rst
new file mode 100644
index 00000000..ca017719
--- /dev/null
+++ b/changelog.d/1379.doc.rst
@@ -0,0 +1 @@
+Minor doc fixes after actually using the new release process.
diff --git a/docs/releases.txt b/docs/releases.txt
index 234f69ee..98ba39e8 100644
--- a/docs/releases.txt
+++ b/docs/releases.txt
@@ -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::