chg: doc: bump changelog for release, add tox cmd to (re)generate cha…

…nges Signed-off-by: Stephen L Arnold <sarnold@vctlabs.com>
sarnold · Sep 5, 2023 · 511577b · 511577b
1 parent 0b48ab6
commit 511577b
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,12 +1,18 @@
 Changelog
 =========
 
+0.2.2 (2023-09-05)
+------------------
 
-(unreleased)
-------------
+New
+~~~
+- Add a changelog file and gitchangelog cfg, add to docs build. [Stephen
+  L Arnold]
 
 Changes
 ~~~~~~~
+- Bump changelog for release, add tox cmd to (re)generate changes.
+  [Stephen L Arnold]
 - Cleanup docstrings and readme usage. [Stephen L Arnold]
 - Still more readme cleanup. [Stephen L Arnold]
 
@@ -16,6 +22,9 @@ Fixes
 
 Other
 ~~~~~
+- Merge pull request #11 from sarnold/docs-cleanup. [Steve Arnold]
+
+  Docs cleanup
 - Merge pull request #10 from sarnold/comments. [Steve Arnold]
 
   Refactor libs, add tests, preserve comments in sorted list

diff --git a/README.rst b/README.rst
@@ -222,6 +222,7 @@ to specify the Python version and host OS type, run something like::
 
 Additional ``tox`` commands:
 
+* ``tox -e changes`` (re)generate the changelog file
 * ``tox -e conv`` round-trip conversion test on mavlink dialect
 * ``tox -e dev`` pip "developer" install
 * ``tox -e style`` will run flake8 style checks
@@ -239,10 +240,10 @@ To build/lint the api docs, use the following tox commands:
 Making Changes & Contributing
 =============================
 
-We use the gitchangelog_ action to generate our github Release page, as
-well as the gitchangelog message format to help it categorize/filter
-commits for a tidier release page. Please use the appropriate ACTION
-modifiers in any Pull Requests.
+We use the gitchangelog_ action to generate our changelog and GH Release
+page, as well as the gitchangelog message format to help it categorize/filter
+commits for a tidier changelog. Please use the appropriate ACTION modifiers
+in any Pull Requests.
 
 This repo is also pre-commit_ enabled for various linting and format
 checks.  The checks run automatically on commit and will fail the

diff --git a/tox.ini b/tox.ini
@@ -158,6 +158,22 @@ commands =
     ymltoxml --dump-config
     ymltoxml requirements.txt out.txt
 
+[testenv:changes]
+skip_install = true
+
+allowlist_externals =
+    {[testenv:conv]allowlist_externals}
+
+passenv =
+    {[testenv:conv]passenv}
+
+deps =
+    pip>=21.1
+    https://github.com/sarnold/gitchangelog/releases/download/3.1.2/gitchangelog-3.1.2-py3-none-any.whl
+
+commands =
+    bash -c 'gitchangelog {posargs} > CHANGELOG.rst'
+
 [testenv:clean]
 skip_install = true
 allowlist_externals =