Update release note generator example to use Couchbase Server

Revised the documentation for the release note generator to replace example configuration for "Sync Gateway" with "Docs Server (test)" for Couchbase Server. Updated Jinja template and adjusted input parameters, fields, and examples accordingly.

Author: RayOffiah

home/modules/contribute/assets/images/release-note-generator/docs-server-test-example.png

@@ -27,7 +27,8 @@ alter the Python script itself. Adding a new product involves two steps:
 
 == Adding a new product
 
-To demonstrate this process, we're going to create a new release note configuration for the Sync Gateway product.
+To demonstrate this process, we're going to create a test release note configuration for Couchbase Server.
+(There are already two existing configurations for this product, so this one can be safely deleted later).
 
 NOTE: You should run the following commands from the directory where your Release Notes Generator is installed.
 
@@ -48,7 +49,7 @@ and add the new `name` item underneath the `release_settings` section:
 [source, yaml]
 ----
 release_settings:
-  - name: "Sync Gateway"
+  - name: "Docs Server (test)"
 ----
 
 === Step {counter: step}: Define your parameters
@@ -60,12 +61,13 @@ The most common parameters are:
 
 [horizontal]
 
-Release number::
-The label that our JQL will use to find the release tag.
-
 Release date::
 This will appear in the release note heading.
 
+
+Release number::
+The label that our JQL will use to find the release tag.
+
 File path::
 This is a mandatory item needed for each release set.
 It supplies the name of the AsciiDoc file that the script generates.
@@ -74,16 +76,17 @@ Other parameters that the SQL will need, (such as the project name), are fixed v
 and don't need to be parameterized.
 
 [source, yaml]
+.Add the input parameters
 ----
 release_settings:
-  - name: "Sync Gateway"
+  - name: "Docs Server (test)"
     fields:
-      - name: release_number
-        type: text
-        message: 'Enter the release number:'
       - name: release_date
         type: text
         message: 'Enter the release date (Month Year):'
+      - name: release_number
+        type: text
+        message: 'Enter the release label:'
       - name: file_path
         type: file
         message: 'Enter the file path for the release notes:'
@@ -96,25 +99,28 @@ Now, you add the URL and the JQL statements used to retrieve the Jira tickets th
 [source, yaml]
 .Adding the JQL statement
 ----
-release_settings:
-  - name: "Sync Gateway"
+  - name: "Docs Server (test)"
     fields:
-      - name: release_number
-        type: text
-        message: 'Enter the release number:'
       - name: release_date
         type: text
         message: 'Enter the release date (Month Year):'
+      - name: release_number
+        type: text
+        message: 'Enter the release label:'
+      - name: release_text
+        type: text
+        message: 'Enter the release number for the title line:'
       - name: file_path
         type: file
         message: 'Enter the file path for the release notes:'
     url: https://jira.issues.couchbase.com
-    jql: project = CBG AND issuetype in (Bug, "New Feature", Improvement) # <.>
-      AND (fixVersion = {{release_number}} OR labels IN (known_issue)) # <.>
+    jql: project = "Couchbase Server" # <.>
+      AND type IN (Epic, Bug, Improvement, Task, "Technical Task")
+      AND fixVersion in ({{release_number}}) # <.>
+      AND labels IN (releasenote,releasenotecomplete)
       ORDER BY key ASC # <.>
-    template: sync-gateway.jinja2
 ----
-<.> Note that the JQL statement restricts the query to tickets belonging to the Sync Gateway project,
+<.> Note that the JQL statement restricts the query to tickets belonging to the Couchbase Server project,
 and also ensures that the ticket is either a Bug or a New Feature.
 <.> We supply the `release_number` parameter to the JQL statement so that we only pick up tickets from the specified release.
 <.> The `ORDER BY key` clause ensures that the tickets are returned in ascending order based on their Jira key.
@@ -132,24 +138,29 @@ For most of the Couchbase projects, this was added some time after the Jira syst
 so the new field was added as a custom field called `customfield_11402`.
 
 [source,yaml, subs="+quotes"]
+.Define the `release_notes_field`
 ----
-  - name: "Sync Gateway"
+  - name: "Docs Server (test)"
     fields:
-      - name: release_number
-        type: text
-        message: 'Enter the release number:'
       - name: release_date
         type: text
         message: 'Enter the release date (Month Year):'
+      - name: release_number
+        type: text
+        message: 'Enter the release label:'
+      - name: release_text
+        type: text
+        message: 'Enter the release number for the title line:'
       - name: file_path
         type: file
         message: 'Enter the file path for the release notes:'
     url: https://jira.issues.couchbase.com
-    jql: project = CBG AND issuetype in (Bug, "New Feature", Improvement)
-      AND (fixVersion = {{release_number}} OR labels IN (known_issue))
+    jql: project = "Couchbase Server"
+      AND type IN (Epic, Bug, Improvement, Task, "Technical Task")
+      AND fixVersion in ({{release_number}})
+      AND labels IN (releasenote,releasenotecomplete)
       ORDER BY key ASC
     #release_note_field: 'customfield_11402'#
-    template: sync-gateway.jinja2
 ----
 
 Any item from the `fields` list can be designated as a `release_note_field` (e.g. the ticket's `summary` field).
@@ -181,79 +192,76 @@ Before creating the rendering template, you need to add it's location to your re
 You can share templates between release sets.
 
 [source,yaml]
-.The completed release set
+.Define the Jinja template
 ----
-release_settings:
-  - name: "Sync Gateway"
+  - name: "Docs Server (test)"
     fields:
-      - name: release_number
-        type: text
-        message: 'Enter the release number:'
       - name: release_date
         type: text
         message: 'Enter the release date (Month Year):'
+      - name: release_number
+        type: text
+        message: 'Enter the release label:'
+      - name: release_text
+        type: text
+        message: 'Enter the release number for the title line:'
       - name: file_path
         type: file
         message: 'Enter the file path for the release notes:'
     url: https://jira.issues.couchbase.com
-    jql: project = CBG AND issuetype in (Bug, "New Feature")
-      AND (fixVersion = {{release_number}} OR labels IN (known_issue))
+    jql: project = "Couchbase Server"
+      AND type IN (Epic, Bug, Improvement, Task, "Technical Task")
+      AND fixVersion in ({{release_number}})
+      AND labels IN (releasenote,releasenotecomplete)
+      AND ("Release Notes[Labels]" NOT IN (suppress-{{release_number}}) OR "Release Notes[Labels]" IS EMPTY)
+      AND summary !~ "System Test" AND resolution not in (Declined, "Won't Fix")
+      AND reporter not in (membersOf(couchbase-qe-team))
       ORDER BY key ASC
-    template: sync-gateway.jinja2
+    release_note_field: 'customfield_11402'
+    template: docs-server-test.jinja2
 ----
 
 === Step {counter: step}: Create your JINJA template
 
 The templates reside in the `templates` directory, as defined near the top of the configuration file.
-Use your editor to create a new template file in this directory. The file should be called `sync-gateway.jinja2`,
+Use your editor to create a new template file in this directory. The file should be called `docs-server-test.jinja2`,
 as defined in the release set configuration. (<<define-your-jinja-template>>)
 
 Copy the template below into your file, then save the file.
 
-[source]
+[source, text]
+.Create the Jinja template
 ----
+{%- macro generate_issue_table(filtered_issues, title, suffix) %} <1>
 
-{% macro generate_issue_list(issues) %} <1>
-
-{%  if issues | length %}
-{% for issue in issues %} <2>
-
-* {{ user_settings.release_set.url }}/browse/{{ issue.key }}[++{{ issue.key }} {{ issue.fields.summary }}++] <3>
-{% endfor %}
-{% else %}
-None for this release.
-{%  endif %}
+{% if filtered_issues | length > 0 -%}
 
-{% endmacro %} <1>
+    {{- "[#dlist-fixed-issues-" ~ user_settings.fields.release_number | replace_dots('') ~ "-" ~ suffix ~ "]\n"}}
+    {{- "=== " ~ title }}
 
-{% set improvements = issues | selectattr('fields.issuetype.name', 'in', 'New Feature,Epic,Improvement') <4>
-| selectattr('fields.status.name', 'in','Resolved, Closed')
-| selectattr('fields.resolution.name', 'in','Fixed, Done')
-| rejectattr('fields.labels', 'contains', 'known_issue') | list %}
+    {% for issue in filtered_issues %} <2>
 
-{% set bugs = issues | selectattr('fields.issuetype.name', 'in', 'Bug')
-| selectattr('fields.resolution.name', 'in','Fixed')
-| rejectattr('fields.labels', 'contains', 'known_issue') | list  %}
+        {{- "*" ~ url_with_jira(user_settings.release_set.url, issue.key) ~ "*::"}} <3>
 
-{% set known_issues = issues  | selectattr('fields.labels', 'contains', 'known_issue')
-| rejectattr('fields.status.name', 'in','Resolved, Closed') | list %}
+        {{- issue.raw['fields'][user_settings.release_set.release_note_field] }} <4>
 
-== {{ user_settings.fields.release_number }} -- {{ user_settings.fields.release_date }}
+   {% endfor %}
 
-[#maint-{{user_settings.fields.release_number | replace_dots('-') }}]
+{%- endif %}
 
-=== Enhancements
-{{ generate_issue_list(improvements) }} <1>
+{%- endmacro %}
 
-=== Issues and Resolutions
 
-==== Fixed Issues
+[#release-{{ user_settings.fields.release_number | replace_dots('') }}]
+== Release {{ user_settings.fields.release_number }} ({{ user_settings.fields.release_date }})
 
-{{ generate_issue_list(bugs) }} <1>
+Couchbase Server {{ user_settings.fields.release_number }} was released in {{ user_settings.fields.release_date }}.
+This maintenance release contains fixes to issues.
 
-==== Known Issues
+{{ "[#dlist-fixed-issues-" ~ user_settings.fields.release_number | replace_dots('') ~ "]"}}
+== Fixed Issues
 
-{{ generate_issue_list(known_issues) }} <1
+{% include "docs-server-components.jinja2" %}
 
 ----
 
@@ -263,7 +271,7 @@ but we will highlight some of the features used in this example:
 <1> We can define reusable macros that can be called from anywhere within the template.
 <2> We can define a `for … endfor` loop to iterate over the list of issues passed to the template.
 <3> We can access all the fields of an issue using the dot notation.
-<4> We can filter the issue list even further by using the built-in `selectattr` function
+<4> Use the parameter `user_settings.release_set.release_note_field` to access the release not description from the ticket.
 to filter issues based on field values.
 
 === Step {counter: step}: Run the Release Note Generator
@@ -275,7 +283,7 @@ From the terminal screen, run the application using the following command:
 ./cb-release-note
 ----
 
-.Running the generator with the new Sync Gateway release set
-image::release-note-generator/sync-gateway-example.png[Running the Release Note Generator]
+.Running the generator with the new release set
+image::release-note-generator/docs-server-test-example.png[Running the Release Note Generator]