proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-13 21:10:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #10727 from ton31337/feature/adjust_release_doc

Browse Source 
doc: Add a couple of handy commands to get some info for release notes
This commit is contained in:
Donald Sharp 2022-03-11 14:29:46 -05:00 committed by GitHub
commit dbaa656ace
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/developer/frr-release-procedure.rst
View 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,10 +220,17 @@ Stage 3 - Publish
This is very important otherwise the announcement will be unreadable on the
website.
Make sure to add a link to the GitHub releases page at the top.
To get the number of commiters and commits, here is a couple of handy commands:
Once finished, manually add a new entry into ``index.html`` to link to this
new announcement. Look at past commits to see how to do this.
.. 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.
#. Deploy the updated ``frr-www`` on the frrouting.org web server and verify
that the announcement text is visible.