MXS Add scripts for generating release notes

Author: jhnwkmn

release-notes/maxscale/script/generate_release_notes.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+
+if [ "$1" == "" ]
+then
+    echo "usage: $0 major.minor.patch [maturity]"
+    exit 1
+fi
+
+VERSION=$1
+
+patch=${VERSION##*.}
+major_minor=${VERSION%.*}
+major=${major_minor%%.*}
+minor=${major_minor##*.}
+
+if [ "$2" == "" ]
+then
+    echo "No maturity specified, assuming GA."
+    maturity="GA"
+else
+    maturity=$2
+fi
+
+if [ ! -d "$major_minor" ]
+then
+    echo "error: $major_minor does not exist or is not a directory."
+    exit 1
+fi
+
+# Script location
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+output=$major.$minor/$VERSION.md
+
+echo Creating/overwriting $output.
+echo
+
+# For version 6, this is just the major version. For other versions, it
+# is $major.$minor. Needs to be updated whenever a new major release is
+# out or if the versioning scheme for MaxScale changes.
+upgrade_version="$major.$minor"
+
+cat <<EOF > $output
+# MariaDB MaxScale ${VERSION} Release Notes
+
+Release ${VERSION} is a ${maturity} release.
+
+This document describes the changes in release ${VERSION}, when compared to the
+previous release in the same series.
+
+If you are upgrading from an older major version of MaxScale, please read the
+[upgrading document](https://app.gitbook.com/s/0pSbu5DcMSW4KwAkUcmX/maxscale-management/deployment/upgrading-maxscale)
+for this MaxScale version.
+
+For any problems you encounter, please consider submitting a bug
+report on [our Jira](https://jira.mariadb.org/projects/MXS).
+
+`${SCRIPT_DIR}/list_fixed.sh ${VERSION}`
+
+## Known Issues and Limitations
+
+There are some limitations and known issues within this version of MaxScale.
+For more information, please refer to the
+[Limitations](https://app.gitbook.com/s/0pSbu5DcMSW4KwAkUcmX/maxscale-management/mariadb-maxscale-limitations-guide)
+document.
+
+## Packaging
+
+RPM and Debian packages are provided for the supported Linux distributions.
+
+Packages can be downloaded [here](https://mariadb.com/downloads).
+
+## Source Code
+
+The source code of MaxScale is tagged at GitHub with a tag, which is identical
+with the version of MaxScale. For instance, the tag of version X.Y.Z of MaxScale
+is \`maxscale-X.Y.Z\`. Further, the default branch is always the latest GA version
+of MaxScale.
+
+The source code is available [here](https://github.com/mariadb-corporation/MaxScale).
+EOF
+
+echo Manually update the following files:
+echo - $major.$minor/$major.$minor-changelog.md
+echo - ./all-releases.md
+echo - ../SUMMARY.md.

release-notes/maxscale/script/list_fixed.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+
+if [ $# -ne 1 ]
+then
+    echo "USAGE: $0 VERSION"
+    exit 1
+fi
+
+# Script location
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+version=$1
+curl -s "https://jira.mariadb.org/sr/jira.issueviews:searchrequest-csv-all-fields/temp/SearchRequest.csv?jqlQuery=project+%3D+MXS+AND+status+%3D+Closed+AND+fixVersion+%3D+$version" | $DIR/process.py

release-notes/maxscale/script/process.py

@@ -0,0 +1,88 @@
+#!/usr/bin/env python3
+
+import sys
+import csv
+import itertools
+
+# Loop over issues. If an issue has a label that starts with 'CVE-',
+# assume the label is a CVE id. If an issue has multiple CVE labels,
+# the issue will be added multiple times (by design).
+#
+def find_cves(issues):
+    cves=[]
+
+    for i in issues:
+        labels_field = i.get('Labels')
+        if labels_field:
+            labels=labels_field.split(',')
+            for label in labels:
+                if label[0:4].upper() == 'CVE-':
+                    cve = {};
+                    cve['Id'] = label
+                    cve['Issue'] = i
+                    cves.append(cve)
+
+    return cves
+
+def print_cves(header, cves):
+    print(header)
+    print()
+
+    for cve in cves:
+        id = cve['Id']
+        i = cve['Issue']
+        print("* [" + id + "](https://www.cve.org/CVERecord?id=" + id + ") Fixed by [" + i['Issue key'] + "](https://jira.mariadb.org/browse/" + i['Issue key'] + ") " + i['Summary'])
+
+    print()
+
+
+bugs = []
+new_features = []
+tasks = []
+
+reader = csv.reader(sys.stdin.readlines())
+field_names = next(reader)
+
+for row in reader:
+    # In case there are multiple values of a particular field, collect
+    # all values separated by a ','.
+    groups = itertools.groupby(zip(field_names, row), key=lambda x: x[0])
+    row = dict([(k, ','.join([v[1] for v in g])) for k, g in groups])
+
+    if row['Issue Type'] == 'Bug':
+        bugs.append(row)
+    elif row['Issue Type'] == 'New Feature':
+        new_features.append(row)
+    elif row['Issue Type'] == 'Task':
+        tasks.append(row)
+
+# Check if some bug-fix fixes a CVE. These are assumed to be CVEs of MaxScale.
+cves = find_cves(bugs)
+
+if len(cves) > 0:
+    print_cves("## CVEs resolved.", cves)
+
+# If there are tasks, check if any of them fixes a CVE, which is assumed
+# to be a non-MaxScale one; e.g. a CVE of an external library.
+if len(tasks) > 0:
+    cves = find_cves(tasks)
+
+    if len(cves) > 0:
+        print_cves("## External CVEs resolved.", cves)
+
+if len(new_features) > 0:
+    print("## New Features")
+    print()
+
+    for f in new_features:
+        print("* [" + f['Issue key'] + "](https://jira.mariadb.org/browse/" + f['Issue key'] + ") " + f['Summary'])
+    print()
+
+
+print("## Bug fixes")
+print()
+
+for b in bugs:
+    print("* [" + b['Issue key'] + "](https://jira.mariadb.org/browse/" + b['Issue key'] + ") " + b['Summary'])
+
+print()