Automatically generate relese notes

As most of the release notes are "boilerplate text", the changing parts can be easily scripted.
mariadb-corporation · Sep 10, 2018 · 6417727 · 6417727
1 parent eed2628
commit 6417727
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 0 deletions.
diff --git a/Documentation/Release-Notes/generate_release_notes.sh b/Documentation/Release-Notes/generate_release_notes.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+
+major=`cmake -P ../../VERSION22.cmake -L|grep 'MAXSCALE_VERSION_MAJOR'|sed 's/.*=//'`
+minor=`cmake -P ../../VERSION22.cmake -L|grep 'MAXSCALE_VERSION_MINOR'|sed 's/.*=//'`
+patch=`cmake -P ../../VERSION22.cmake -L|grep 'MAXSCALE_VERSION_PATCH'|sed 's/.*=//'`
+maturity=`cmake -P ../../VERSION22.cmake -L|grep 'MAXSCALE_MATURITY'|sed 's/.*=//'`
+
+VERSION=${major}.${minor}.${patch}
+
+cat <<EOF > MaxScale-$VERSION-Release-Notes.md
+# 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.
+
+For any problems you encounter, please consider submitting a bug
+report on [our Jira](https://jira.mariadb.org/projects/MXS).
+
+`../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](../About/Limitations.md) document.
+
+## Packaging
+
+RPM and Debian packages are provided for supported the Linux distributions.
+
+Packages can be downloaded [here](https://mariadb.com/downloads/mariadb-tx/maxscale).
+
+## 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
diff --git a/VERSION20.cmake b/VERSION20.cmake
@@ -10,5 +10,7 @@ set(MAXSCALE_VERSION_PATCH "3" CACHE STRING "Patch version")
 # This should only be incremented if a package is rebuilt
 set(MAXSCALE_BUILD_NUMBER 1 CACHE STRING "Release number")
 
+set(MAXSCALE_MATURITY "GA" CACHE STRING "Release maturity")
+
 set(MAXSCALE_VERSION_NUMERIC "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")
 set(MAXSCALE_VERSION "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")
diff --git a/VERSION21.cmake b/VERSION21.cmake
@@ -10,5 +10,7 @@ set(MAXSCALE_VERSION_PATCH "18" CACHE STRING "Patch version")
 # This should only be incremented if a package is rebuilt
 set(MAXSCALE_BUILD_NUMBER 1 CACHE STRING "Release number")
 
+set(MAXSCALE_MATURITY "GA" CACHE STRING "Release maturity")
+
 set(MAXSCALE_VERSION_NUMERIC "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")
 set(MAXSCALE_VERSION "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")
diff --git a/VERSION22.cmake b/VERSION22.cmake
@@ -10,5 +10,7 @@ set(MAXSCALE_VERSION_PATCH "14" CACHE STRING "Patch version")
 # This should only be incremented if a package is rebuilt
 set(MAXSCALE_BUILD_NUMBER 1 CACHE STRING "Release number")
 
+set(MAXSCALE_MATURITY "GA" CACHE STRING "Release maturity")
+
 set(MAXSCALE_VERSION_NUMERIC "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")
 set(MAXSCALE_VERSION "${MAXSCALE_VERSION_MAJOR}.${MAXSCALE_VERSION_MINOR}.${MAXSCALE_VERSION_PATCH}")