Update documentation on how to generate release-notes 79/64479/1
authorThanh Ha <thanh.ha@linuxfoundation.org>
Wed, 18 Oct 2017 19:07:15 +0000 (15:07 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Wed, 18 Oct 2017 19:14:21 +0000 (19:14 +0000)
Change-Id: I2f0cd739fe09f12d7483589222a3cf60131de1ad
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/release-process/simultaneous-release.rst

index 78e6c4f194f8f0728a02466eb07452ca832f340e..e243fd462aa14e7cbcec76dc68ffd98222946c90 100644 (file)
@@ -103,18 +103,18 @@ Releasing OpenDaylight
 - Run autorelease-generate-release-notes-${STREAM} job
   **(Release Engineering Team)**
 
-  This job is run a the end of every autorelease build can be used only for
-  service releases (SR). The release notes file (release_notes.rst) is available
-  under archives. For major releases (Nitrogen, Carbon) the docs repository has
-  to branched and published which is only done after release reviews are
-  completed.
+  Trigger this job by leaving a Gerrit comment `generate-release-notes Carbon-SR2`
 
-  Release notes can also be manually generated with the script.
+  .. important:: This job can only be used to generate service releases.
+
+  For major releases the notes come from the projects themselves in the docs
+  repo via the `docs/releaset-notes/projects` directory.
+
+  Release notes can also be manually generated with the script:
 
   .. code-block:: bash
 
       git checkout stable/${BRANCH,,}
-      cd scripts/release_notes_management/ && ./build.sh
+      ./scripts/release-notes-generator.sh Carbon-SR2
 
-  The output file (release_notes.rst) generated by the build script is available
-  under autorelease/scripts/release_notes_management/projects/.
+  A `release-notes.rst` will be generated in the working directory.