diff options
| author | Donald Sharp <donaldsharp72@gmail.com> | 2022-03-11 14:29:46 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-11 14:29:46 -0500 |
| commit | dbaa656ace294ac7a2fc57a729e2f28cd58617ee (patch) | |
| tree | 233028b233697e3c6696bb7e0fc8e388e52b8970 | |
| parent | 89ee4bbb21d628b7cabbc54c9cf23064d3295484 (diff) | |
| parent | cd16c683769ee2169bf921421fa67141cd215262 (diff) | |
Merge pull request #10727 from ton31337/feature/adjust_release_doc
doc: Add a couple of handy commands to get some info for release notes
| -rw-r--r-- | doc/developer/frr-release-procedure.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/developer/frr-release-procedure.rst b/doc/developer/frr-release-procedure.rst index 6a7f9c4ca9..4ef0ca8416 100644 --- a/doc/developer/frr-release-procedure.rst +++ b/doc/developer/frr-release-procedure.rst @@ -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: + + .. code-block:: console - 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. + # 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. |