Document release process in DEVELOPMENT

sarugaku · Oct 9, 2021 · 4c01d9e · 4c01d9e
1 parent 0cdf772
commit 4c01d9e
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git 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/DEVELOPMENT.rst b/DEVELOPMENT.rst
@@ -25,3 +25,24 @@ Submitting Pull Requests
 Please make sure any changes are covered by existing tests or that new tests are added.
 ResolveLib is used on many different python versions and operating systems and environments so every effort must be made in order to keep code portable.
 Pull requests should be small to facilitate easier review.
+
+
+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.
diff --git a/README.rst b/README.rst
@@ -87,4 +87,4 @@ A Requirement should specify two things: a Package, and a Specifier.
 Contributing
 ============
 
-Please see `developer documentation <./CONTRIBUTING.rst>`__.
+Please see `developer documentation <./DEVELOPMENT.rst>`__.