RHIDP-6391 Release notes script to stop using the issue title (redhat-developer#980)

* RHIDP-6391 Release notes script to not use the issue title for the release notes section

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* Update modules/release-notes/README.adoc

* Update modules/release-notes/README.adoc

---------

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

Author: themr0c

modules/release-notes/README.adoc

@@ -0,0 +1,46 @@
+= Single-sourcing release notes
+
+== Single-sourcing general purpose release notes
+
+The general purpose release notes content is single-sourced from link:https://issues.redhat.com/browse/RHIDP[the JIRA project].
+
+.Prerequisites
+* In link:https://issues.redhat.com/secure/Dashboard.jspa?selectPageId=12364101#SIGwKWmOqDCVBoapBCJiDqhoiKInaroYEg9j2PldSYMUcQVVVdrFHVDUxs1uBtQolXVZgDTdZwjXSCNOA1u11Xeog9Xjb100DUNCh2jwi0TVgzWteeg2FC1TmbT1TUrftGiFHa2CjQtp2TX1DnIGgGCIgEKI+iQfrUlV2AvkJQA[the JIRA project]:
+** *Fix Version/s* is set.
+** *Release Notes Text* is set using following format: a level 0 title followed by descriptive content, such as:
++ 
+.*Release Notes Text* sample
+----
+= Configurable PVC mounting for containers
+
+Previously, the default Persistent Volume Claim (PVC) could only be mounted to the Backstage container. With this update, you can now configure which container(s) the PVC should be mounted to, providing greater flexibility in storage management. 
+----
+** *Release Notes Type* is set to `Enhancement`, `Feature`, `Removed Functionality`, `Deprecated Functionality`, `Developer Preview`, `Technology Preview`, `Known Issue`, or `Bug Fix`.
+** *Release Notes Status* is set to `Done`.
+
+* On the single-sourcing environment: Bash, Git, Python, and Pip are installed.
+
+.Procedure
+. Verify the `product-version` and `product-bundle-version` attributes values in the `artifacts/attributes.adoc` file.
+
+. Open a terminal and change directory to the Git repository root.
+
+. Install required python modules.
++
+----
+$ pip3 install --requirement requirements.txt
+----
+
+. Single-source content from JIRA.
++
+----
+$ python modules/release-notes/single-source-release-notes.py
+----
+
+.Verification
+* Verify the changed content:
++
+----
+$ git diff
+----
+

modules/release-notes/single-source-release-notes-template.adoc.jinja

@@ -10,11 +10,11 @@
 == {{ title }} in {{ fixversion }}
 {% endif %}
 [id="{{ issue.fields.customfield_12320850 | lower | replace(" ", "-") }}-{{ issue.key | lower }}"]
-=== {{ issue.fields.summary }}
-{% else -%}
+==
+{%- else -%}
 [id="{{ issue.fields.customfield_12320850 | lower | replace(" ", "-") }}-{{ issue.key | lower }}"]
-== {{ issue.fields.summary }}
-{% endif %}
+=
+{%- endif -%}
 {{ issue.fields.customfield_12317313 }}
 {% if template == "with-jira-link" or template == "with-z-stream-section" %}
 

modules/release-notes/single-source-release-notes.jira2asciidoc.yml

@@ -69,7 +69,7 @@ sections:
   - id: fixed-issues
     title: Fixed issues
     description: |
-      This section lists issues fixed in {product} {product-version}.
+      This section lists issues fixed in {product} {product-version} that have a significant impact on users.
     query: >
       project = "Red Hat Internal Developer Platform"
       AND "Release Note Status" = "Done"

modules/release-notes/single-source-release-notes.py

@@ -47,11 +47,8 @@
       items = lines.rsplit(':', 2)
       attributes[items[1]] = items[2].strip()
 
-product_version_minor = attributes["product-version"]
+product_version_minor = attributes["product-version"] + ".0"
 product_version_patch = attributes["product-bundle-version"]
-# Until 1.4 at least, Jira has no z-stream 0. Use the y-stream instead.
-if re.search('.0$',product_version_patch):
-  product_version_patch = product_version_minor
 
 # Load the configuration file to get the sections and their Jira queries.
 with open(config_file) as file: