diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ed3e4c4..155bc65 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,7 +1,3 @@ -0.8.0 (2021-10-08) -No significant changes. - - 0.8.0 (2021-10-08) ================== diff --git a/README.rst b/README.rst index 48fac07..fd9e091 100644 --- a/README.rst +++ b/README.rst @@ -88,3 +88,23 @@ Contributing ============ Please see `developer documentation <./CONTRIBUTING.rst>`__. + +Release process for maintainers +=============================== + +Replace ``X.Y.Z`` with the release you would like to make. + +* Make sure the news fragments are in place. +* ``nox -s release -- --repo https://upload.pypi.org/legacy/ --prebump X.Y.Z+1.dev0 --version X.Y.Z`` +* ``git push origin master --tags`` +* ``git push upstream master --tags`` + +Breakdown of the ``release`` nox task: + +* Writes ``X.Y.Z`` to ``src/resolvelib/__init__.py``. +* Runs ``towncrier`` to update the changelog and delete news fragments. +* Commit the changelog and version change. +* Tag the commit as release ``X.Y.Z``. +* Build, check, and upload distributions to the index specified by ``repo``. +* Writes ``X.Y.Z+1.dev0`` to ``src/resolvelib/__init__.py``. +* Commit the "prebump" change.