doc: Add a couple of handy commands to get some info for release notes

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
This commit is contained in:
Donatas Abraitis 2022-03-04 09:46:25 +02:00
parent 7469f084f3
commit 5c1d285012

View File

@ -204,7 +204,7 @@ Stage 3 - Publish
.. code-block:: console .. 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 Paste the GitHub release announcement text into this document, and **remove
line breaks**. In other words, this:: 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 This is very important otherwise the announcement will be unreadable on the
website. 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. 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 Once finished, manually add a new entry into ``index.html`` to link to this