Skip to content

Commit

Permalink
Release aftermath.
Browse files Browse the repository at this point in the history
  • Loading branch information
icemac committed Dec 20, 2023
1 parent aada78d commit fe7e939
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
13 changes: 8 additions & 5 deletions docs/process/updating-ztk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ To get new version pins into ZTK run the following steps:
is needed to omit the other rubbish rendered by the command call.)
* Update ``ztk-versions.cfg`` with these new versions and run ``tox`` to run their
tests.
* Run the checkversion call from above again to make sure all possible versions
are updated.
* 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
Expand All @@ -24,15 +24,18 @@ Creating a release
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
* Create a change log page in ``docs/releases`` with the name of your release
number and describe the most important changes in the new release.

* Mention that the buildout versions file can be found at
https://zopefoundation.github.io/zopetoolkit/.
* 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``.
* Commit your newly added file and the changes 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
* Push the changes to GitHub, after some minutes the changes should appear at
https://zopefoundation.github.io/zopetoolkit/.
3 changes: 3 additions & 0 deletions docs/releases/2.0.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
2.0 (2023-12-18)
================

Please find the buildout versions file at
https://zopefoundation.github.io/zopetoolkit/.

Breaking changes
----------------

Expand Down
4 changes: 1 addition & 3 deletions ztk.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2010 Zope Foundation and Contributors.
# Copyright (c) 2010-2023 Zope Foundation and Contributors.
#
# This is the specification file for the Zope Toolkit.

Expand Down Expand Up @@ -77,9 +77,7 @@ deprecating =
packages = ${ztk:included}
${ztk:deprecating}


[buildout]
extends =
ztk-sources.cfg
ztk-versions.cfg
versions = versions

0 comments on commit fe7e939

Please sign in to comment.