11Updating the ZTK itself
22=======================
33
4+ Updating versions of dependencies
5+ ---------------------------------
6+
47To 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/.
0 commit comments