Skip to content

Commit 7e05ef2

Browse files
swlarsSarah Larsen
andauthored
Update release documentation. (#1580)
Co-authored-by: Sarah Larsen <[email protected]>
1 parent 57bbb05 commit 7e05ef2

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Source code and issue tracker: https://github.com/esnet/iperf
3232

3333
Discussion forums: https://github.com/esnet/iperf/discussions
3434

35+
Reporting security vulnerabilities: [email protected]
36+
3537
Obtaining iperf3
3638
----------------
3739

docs/dev.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Then submit to the iperf3 issue tracker on GitHub:
3030

3131
https://github.com/esnet/iperf/issues
3232

33+
For reporting potential security issues, please contact the developers at
34+
35+
3336
**Note:** Issues submitted to the old iperf3 issue tracker on Google
3437
Code (or comments to existing issues on the Google Code issue tracker)
3538
will be ignored.
@@ -130,8 +133,8 @@ The developers increment the:
130133
Release Engineering Checklist
131134
-----------------------------
132135

133-
1. Update the ``README`` and ``RELNOTES.md`` files to be accurate. Make sure
134-
that the "Known Issues" section of the ``README`` file and in this document
136+
1. Update the ``README.md`` and ``RELNOTES.md`` files to be accurate. Make sure
137+
that the "Known Issues" section of the ``README.md`` file and in this document
135138
are up to date.
136139

137140
2. Compose a release announcement. Most of the release announcement
@@ -214,12 +217,14 @@ Release Engineering Checklist
214217
sending process by sending a copy to oneself first and attempting
215218
to verify the signature is highly encouraged.
216219

217-
12. Update the iperf3 Project News section of the documentation site
220+
12. Update GitHub Releases with the current release notes.
221+
222+
13. Update the iperf3 Project News section of the documentation site
218223
to announce the new release (see ``docs/news.rst`` and
219224
``docs/conf.py`` in the source tree) and deploy a new build of the
220225
documentation to GitHub Pages.
221226

222-
13. If an update to the on-line manual page is needed, it can be
227+
14. If an update to the on-line manual page is needed, it can be
223228
generated with this sequence of commands (tested on CentOS 7) and
224229
import the result into ``invoking.rst``::
225230

0 commit comments

Comments
 (0)