docs/templates/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 Release Notes
   6 =============
   7
   8 .. note::
   9         * This Release Notes must be updated each time the team decides to Release new artifacts.
  10         * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
  11         * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  12         * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
  13         * This note must be removed after content has been added.
  14
  15
  16 Version: x.y.z
  17 --------------
  18
  19
  20 :Release Date: yyyy-mm-dd
  21
  22
  23
  24 **New Features**
  25
  26 One or two sentences explaining the purpose of this Release.
  27
  28 **Bug Fixes**
  29         - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
  30 **Known Issues**
  31         - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
  32           One sentences explaining what is the issue.
  33
  34           Another sentence explaining the impact of the issue.
  35
  36           And an optional sentence providing a workaround.
  37
  38 **Security Issues**
  39         You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
  40
  41
  42 **Upgrade Notes**
  43
  44 **Deprecation Notes**
  45
  46 **Other**
  47
  48 ===========
  49
  50 End of Release Notes