From 7e05ef25c89d4633b299328f0f3e254a17f29346 Mon Sep 17 00:00:00 2001 From: swlars <89053414+swlars@users.noreply.github.com> Date: Mon, 2 Oct 2023 11:13:18 -0700 Subject: [PATCH] Update release documentation. (#1580) Co-authored-by: Sarah Larsen --- README.md | 2 ++ docs/dev.rst | 13 +++++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 664b6f020..f569d3a38 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ Source code and issue tracker: https://github.com/esnet/iperf Discussion forums: https://github.com/esnet/iperf/discussions +Reporting security vulnerabilities: iperf@es.net + Obtaining iperf3 ---------------- diff --git a/docs/dev.rst b/docs/dev.rst index 98548b478..c65524bc7 100644 --- a/docs/dev.rst +++ b/docs/dev.rst @@ -30,6 +30,9 @@ Then submit to the iperf3 issue tracker on GitHub: https://github.com/esnet/iperf/issues +For reporting potential security issues, please contact the developers at +iperf@es.net. + **Note:** Issues submitted to the old iperf3 issue tracker on Google Code (or comments to existing issues on the Google Code issue tracker) will be ignored. @@ -130,8 +133,8 @@ The developers increment the: Release Engineering Checklist ----------------------------- -1. Update the ``README`` and ``RELNOTES.md`` files to be accurate. Make sure - that the "Known Issues" section of the ``README`` file and in this document +1. Update the ``README.md`` and ``RELNOTES.md`` files to be accurate. Make sure + that the "Known Issues" section of the ``README.md`` file and in this document are up to date. 2. Compose a release announcement. Most of the release announcement @@ -214,12 +217,14 @@ Release Engineering Checklist sending process by sending a copy to oneself first and attempting to verify the signature is highly encouraged. -12. Update the iperf3 Project News section of the documentation site +12. Update GitHub Releases with the current release notes. + +13. Update the iperf3 Project News section of the documentation site to announce the new release (see ``docs/news.rst`` and ``docs/conf.py`` in the source tree) and deploy a new build of the documentation to GitHub Pages. -13. If an update to the on-line manual page is needed, it can be +14. If an update to the on-line manual page is needed, it can be generated with this sequence of commands (tested on CentOS 7) and import the result into ``invoking.rst``::