Prepare 2.0 release.

zopefoundation · Dec 18, 2023 · aada78d · aada78d
1 parent 2e1ee6b
commit aada78d
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 4 deletions.
diff --git a/docs/attic/releases/index.rst b/docs/attic/releases/index.rst
@@ -1,8 +1,7 @@
-.. This file is generated. Please do not edit manually or check in.
+.. _old-releases:
 
-
-Releases
-========
+Old releases
+============
 
 This area collects release-specific information about the toolkit including a
 list of backward-incompatible changes, new techniques developed, and libraries

diff --git a/docs/index.rst b/docs/index.rst
@@ -41,5 +41,6 @@ Documentation
 
    about
    process/index
+   releases/index
    codingstyle/index
    attic/index
diff --git a/docs/process/updating-ztk.rst b/docs/process/updating-ztk.rst
@@ -1,6 +1,9 @@
 Updating the ZTK itself
 =======================
 
+Updating versions of dependencies
+---------------------------------
+
 To get new version pins into ZTK run the following steps:
 
 * ``tox -e checkversions | grep "="``
@@ -12,3 +15,24 @@ To get new version pins into ZTK run the following steps:
 * Run the checkversion call from above again to make sure all possible versions
   are updated.
 * If the test runs are successful: create a pull request on GitHub.
+
+Creating a release
+------------------
+
+* Make sure all tests are running successfully.
+* Decide on a version number for the new release, taking https://semver.org/
+  into account. (Please note: dropping support for a Python version is
+  considered a major change as it enforces changes for users of ZTK who are
+  using the no longer supported Python version.)
+* Create a change log page in ``doc/releases`` with the name of your release
+  number and describe the most important changes in the new release.
+* Add the name of the file to ``doc/releases/index.rst``.
+* Check the documentation builds using ``tox -e docs`` and proof-read your
+  changes.
+* Commit your newly added file via ``git``.
+* Create a git tag using ``git tag`` and your version number.
+* Push your changes, make sure also the tag is pushed.
+* Switch to the branch ``gh-pages``.
+* Run ``build_indexes.sh``, add and commit the changes.
+* Push the changes to GitHub, after some seconds the changes should appear at
+  https://zopefoundation.github.io/zopetoolkit/.
diff --git a/docs/releases/2.0.rst b/docs/releases/2.0.rst
@@ -0,0 +1,21 @@
+2.0 (2023-12-18)
+================
+
+Breaking changes
+----------------
+
+* Drop support for Python 2.7.
+
+* Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.
+
+Features
+--------
+
+* Update dependencies to newest versions. Some of them even support Python
+  3.12.
+
+Bugfixes
+--------
+
+* There are way too many to list them here separately. See the change logs of
+  the individual packages.
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
@@ -0,0 +1,11 @@
+Releases
+========
+
+After some years without releases of the ZTK, there are now releases again.
+The old releases are in :ref:`old-releases`.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   2.0.rst