]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: Add a couple of handy commands to get some info for release notes
authorDonatas Abraitis <donatas@opensourcerouting.org>
Fri, 4 Mar 2022 07:46:25 +0000 (09:46 +0200)
committerDonatas Abraitis <donatas@opensourcerouting.org>
Fri, 4 Mar 2022 07:46:25 +0000 (09:46 +0200)
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
doc/developer/frr-release-procedure.rst

index 6a7f9c4ca97df7b647eac1abc45cfa3066f51e6e..0913b17120528b862b212d7b7ffadb46dd99e3c1 100644 (file)
@@ -204,7 +204,7 @@ Stage 3 - Publish
 
    .. code-block:: console
 
-      cp <old-version>.md <version>.md
+      cp content/release/<old-version>.md content/release/<new-version>.md
 
    Paste the GitHub release announcement text into this document, and **remove
    line breaks**. In other words, this::
@@ -220,6 +220,16 @@ Stage 3 - Publish
    This is very important otherwise the announcement will be unreadable on the
    website.
 
+   To get the number of commiters and commits, here is a couple of handy commands:
+
+   .. code-block:: console
+
+      # The number of commits
+      % git log --oneline --no-merges base_8.2...base_8.1 | wc -l
+
+      # The number of commiters
+      % git shortlog --summary --no-merges base_8.2...base_8.1 | wc -l
+
    Make sure to add a link to the GitHub releases page at the top.
 
    Once finished, manually add a new entry into ``index.html`` to link to this