gnunet-handbook

The GNUnet Handbook
Log | Files | Refs

commit 93be11c8cd5f40438af121a4ac23ce19b097e3f9
parent 8e86ac27a90925e6ac85330e8d28413253811e48
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Wed, 17 Sep 2025 11:28:18 +0200

update instructions release

Diffstat:
Mdevelopers/style.rst | 30+++++++++++++++++++++++-------
1 file changed, 23 insertions(+), 7 deletions(-)

diff --git a/developers/style.rst b/developers/style.rst @@ -514,17 +514,31 @@ In this order do: 8. Write release announcement -**(1)** First, make sure the ``contrib/handbook`` submodule -is up to date by entering the respective directory and execute: +**(1)** Make sure the ``contrib/handbook`` submodule +is up to date. +In the **handbook repository**, make sure you have a folder that +contains the ``prebuilt`` branch as a worktree: .. code-block:: console - $ git pull origin master + $ git worktree add _build prebuilt -If any of the submodules were updated, commit the new submodule. +Then compile the current handbook: -**(2)** You should now run ``./bootstrap`` once in order to re-generate header files from -the gana submodule and/or po files: +.. code-block:: console + + $ sphinx-multiversion --dump-metadata . _build + +Commit the changes (if any) and update the submoduce in the +gnunet repository under ``doc/handbook`` and execute: + +.. code-block:: console + + $ git pull origin prebuilt + +If the submodule was updated, commit the new submodule. + +**(2)** You should now re-run bootstrap:: .. code-block:: console @@ -533,7 +547,9 @@ the gana submodule and/or po files: **(3)** If this is a major release, it makes sense to update the bootstrap peer HELLO. For this, you need access to the bootstrap peer (``GKZS``) and create -the hello file. It is recommended to have it expire within a year: +the hello file. Make sure that you update the bootstrap peer first such that +any changes in the identity format are actually refrected! +It is recommended to have it expire within a year: .. code-block:: console