From b0317265b1ef646fa1433e0a6a12e0b0783e0257 Mon Sep 17 00:00:00 2001 From: Donatas Abraitis Date: Sat, 4 Nov 2023 16:32:01 +0200 Subject: [PATCH] doc: Add a quick example on how to use release_notes.py Signed-off-by: Donatas Abraitis --- doc/developer/frr-release-procedure.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/developer/frr-release-procedure.rst b/doc/developer/frr-release-procedure.rst index 9378637ded..9dbc9b48d7 100644 --- a/doc/developer/frr-release-procedure.rst +++ b/doc/developer/frr-release-procedure.rst @@ -13,6 +13,13 @@ Stage 1 - Preparation Note: use ``tools/release_notes.py`` to help draft release notes changelog + .. code-block:: console + + ./tools/release_notes.py -b dev/9.1 -t frr-9.0.1 + + dev/9.1 is the branch to be renamed to stable/9.1, and frr-9.0.1 in this + example is the latest tag from which to generate the logs. + #. Checkout the existing ``dev/`` branch. .. code-block:: console -- 2.39.5