Skip to content

Commit aada78d

Browse files
committed
Prepare 2.0 release.
1 parent 2e1ee6b commit aada78d

File tree

5 files changed

+60
-4
lines changed

5 files changed

+60
-4
lines changed

docs/attic/releases/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
.. This file is generated. Please do not edit manually or check in.
1+
.. _old-releases:
22

3-
4-
Releases
5-
========
3+
Old releases
4+
============
65

76
This area collects release-specific information about the toolkit including a
87
list of backward-incompatible changes, new techniques developed, and libraries

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ Documentation
4141

4242
about
4343
process/index
44+
releases/index
4445
codingstyle/index
4546
attic/index

docs/process/updating-ztk.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Updating the ZTK itself
22
=======================
33

4+
Updating versions of dependencies
5+
---------------------------------
6+
47
To get new version pins into ZTK run the following steps:
58

69
* ``tox -e checkversions | grep "="``
@@ -12,3 +15,24 @@ To get new version pins into ZTK run the following steps:
1215
* Run the checkversion call from above again to make sure all possible versions
1316
are updated.
1417
* If the test runs are successful: create a pull request on GitHub.
18+
19+
Creating a release
20+
------------------
21+
22+
* Make sure all tests are running successfully.
23+
* Decide on a version number for the new release, taking https://semver.org/
24+
into account. (Please note: dropping support for a Python version is
25+
considered a major change as it enforces changes for users of ZTK who are
26+
using the no longer supported Python version.)
27+
* Create a change log page in ``doc/releases`` with the name of your release
28+
number and describe the most important changes in the new release.
29+
* Add the name of the file to ``doc/releases/index.rst``.
30+
* Check the documentation builds using ``tox -e docs`` and proof-read your
31+
changes.
32+
* Commit your newly added file via ``git``.
33+
* Create a git tag using ``git tag`` and your version number.
34+
* Push your changes, make sure also the tag is pushed.
35+
* Switch to the branch ``gh-pages``.
36+
* Run ``build_indexes.sh``, add and commit the changes.
37+
* Push the changes to GitHub, after some seconds the changes should appear at
38+
https://zopefoundation.github.io/zopetoolkit/.

docs/releases/2.0.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2.0 (2023-12-18)
2+
================
3+
4+
Breaking changes
5+
----------------
6+
7+
* Drop support for Python 2.7.
8+
9+
* Add support for Python 3.7, 3.8, 3.9, 3.10, 3.11.
10+
11+
Features
12+
--------
13+
14+
* Update dependencies to newest versions. Some of them even support Python
15+
3.12.
16+
17+
Bugfixes
18+
--------
19+
20+
* There are way too many to list them here separately. See the change logs of
21+
the individual packages.

docs/releases/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Releases
2+
========
3+
4+
After some years without releases of the ZTK, there are now releases again.
5+
The old releases are in :ref:`old-releases`.
6+
7+
8+
.. toctree::
9+
:maxdepth: 1
10+
11+
2.0.rst

0 commit comments

Comments
 (0)