Tweak release notes: better version strings (#207)

* Add signature recipe * Fix signature part in README: now has "flake8-" prefix * Update release checklist: stop using v in releases for branches * Don't need to fish version strings out of tox output any more * Update Changelog
jamescooke · Mar 1, 2023 · c0e65a1 · c0e65a1
1 parent 8440dbb
commit c0e65a1
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 16 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -20,6 +20,13 @@ Additional markers for types of change copied from ``README``:
 Unreleased_
 -----------
 
+Changed
+.......
+
+* ⛏️ Release notes updated to use a better method of updating Flake8 version
+  strings. Also reduce use of ``vx.y.z`` version strings - use just ``x.y.z``
+  instead.
+
 See also `latest documentation
 <https://flake8-aaa.readthedocs.io/en/latest/#__unreleased_marker__>`_.
 

diff --git a/Makefile b/Makefile
@@ -66,6 +66,11 @@ cmdbad:
 
 # --- Local dev: Building / Publishing ---
 
+# Generate version signature used in README.rst
+.PHONY: signature
+signature:
+	tox e -e py311-meta_plugin -- flake8 --version
+
 .PHONY: clean
 clean:
 	rm -rf dist build .tox .pytest_cache src/flake8_aaa.egg-info

diff --git a/README.rst b/README.rst
@@ -169,8 +169,8 @@ string:
 
     6.0.0 (flake8-aaa: 0.13.1, mccabe: 0.7.0, pycodestyle: 2.10.0, pyflakes: 3.0.1) CPython 3.11.0 on Linux
 
-The ``aaa: 0.13.1`` part tells you that Flake8-AAA was installed successfully
-and its checks will be used by Flake8.
+The ``flake8-aaa: 0.13.1`` part tells you that Flake8-AAA was installed
+successfully and its checks will be used by Flake8.
 
 Further reading:
 

diff --git a/docs/release_checklist.rst b/docs/release_checklist.rst
@@ -10,30 +10,25 @@ Versioning
 Given a new version called ``x.y.z``:
 
 * Create a branch for the new release. Usually called something like
-  ``bump-vx.y.z``.
+  ``bump-x.y.z``.
 
 * Run ``./bump_version.sh [x.y.z]``.
 
-* Commit changes and push ``bump-vx.y.z`` branch for testing.
+* Ensure command line output examples in ``README.rst`` are up to date. Run:
 
-Documentation
--------------
+  .. code-block:: shell
 
-Now is a good time to build and check the documentation locally:
+      make signature
 
-.. code-block:: shell
+  Update the version string in the README.
 
-    make doc
-    firefox docs/_build/html/index.html
-
-
-Ensure that command line output examples are up to date. They can be updated
-using the output of the ``cmd`` and ``cmdbad`` ``tox`` environments.
+* Commit changes and push ``bump-x.y.z`` branch for testing. Use ``Bump to
+  x.y.z`` as the PR title.
 
 Merge
 -----
 
-* When branch ``bump-vx.y.z`` is green, then merge it to ``master``. All pull
+* When branch ``bump-x.y.z`` is green, then merge it to ``master``. All pull
   requests are "squash merged".
 
 * Update master locally and ensure that you remain on master for the rest of

diff --git a/tox.ini b/tox.ini
@@ -135,7 +135,6 @@ labels =
 deps =
     flake8>=4
 commands =
-    flake8 --version
     flake8 tests
     flake8 examples/good
     - bash -c "flake8 examples/bad/ | sort > {envtmpdir}/out"