#137 automatic changelog creation added

Author: Michael Mrowetz

Diff for: Gruntfile.js

@@ -1,16 +1,20 @@
 const path = require("path");
 const process = require("process");
 const gruntBump = require("grunt-bump")
-
+/**
+ * @param  {IGrunt} grunt - Grunt instance
+ */
 module.exports = function (grunt) {
   "use strict";
 
-
   /** Version banner for static files (keep version format for "grunt-bump") */
   const banner = "/*! github.com/micmro/PerfCascade Version:<%= package.version %> <%= grunt.template.today(\"(dd/mm/yyyy)\") %> */\n";
   let releaseIncrement = ["major", "minor"]
     .indexOf(grunt.option('release-increment')) != -1 ? grunt.option('release-increment') : "patch";
 
+  // manually load custom task
+  require("./build-utils/grunt-tasks/changelog-custom")(grunt)
+
   // automatically loads configurations from `./grunt-config/*`
   require('load-grunt-config')(grunt, {
     configPath: path.join(process.cwd(), 'build-utils/grunt-config'),
@@ -60,6 +64,7 @@ module.exports = function (grunt) {
     "preBuild",
     `bump-only:${releaseIncrement}`,
     "releaseBuild",
+    "changelog-custom",
     "commitAndPush"
   ]);
 

Diff for: build-utils/grunt-config/changelog-custom.js

@@ -0,0 +1,6 @@
+module.exports = {
+  options: {
+    version: 'v<%= package.version %>',
+    file: 'CHANGELOG.md'
+  }
+}

Diff for: build-utils/grunt-config/run.js

@@ -27,7 +27,6 @@ module.exports = {
     options: {
       cwd: process.cwd()
     },
-    exec: `(export VERSION=<%= package.version %> && bash build-utils/release.sh)`
-
+    exec: `(export VERSION=<%= package.version %> && export CHANGELOG="<%= changelog %>" && bash build-utils/release.sh)`
   }
 };

Diff for: build-utils/grunt-tasks/changelog-custom.js

@@ -0,0 +1,43 @@
+let fs = require('fs')
+let conventionalChangelog = require('conventional-changelog');
+
+/**
+ * @param  {IGrunt} grunt - Grunt instance
+ */
+module.exports = function(grunt){
+  let PassThroughStream = require('stream').PassThrough;
+
+  grunt.registerTask('changelog-custom', 'Custom version of changelog', function() {
+    const done = this.async();
+    const options = this.options()
+    let readDataStream = new PassThroughStream();
+    let tmpBuffer = "";
+
+    // extract data
+    readDataStream
+      .on('data', (chunk) => tmpBuffer += chunk)
+      .on('end', () => {
+        grunt.config.data.changelog = tmpBuffer
+        readDataStream.end()
+      })
+
+    // changlog file writer
+    let appenFileStream = fs.createWriteStream(options.file, {'flags': 'a'})
+      .on('error', grunt.log.error)
+      .on('close', () => {
+        grunt.log.ok(`${options.file} updated with latest changelog for ${options.version}`)
+        done();
+      })
+
+    // get changelog
+    conventionalChangelog({
+      config: {
+        warn : grunt.warn,
+        pkg: grunt.package
+      }
+    }, {
+      version: options.version
+    }).pipe(readDataStream).pipe(appenFileStream) // or any writable stream
+  });
+
+}

Diff for: build-utils/release.sh

@@ -9,9 +9,10 @@
 : "${VERSION?Need to set VERSION environment variable}"
 : "${GITHUB_TOKEN?Need to set GITHUB_TOKEN environment variable}"
 
-
 echo "Start Github release for ${VERSION}..."
 
+CHANGELOG=${CHANGELOG}
+
 ###
 # Github Release
 ###
@@ -44,7 +45,7 @@ echo "make Github release"
 # make releases
 # TODO: make final not draft once confirmed working
 # TODO: add Changelog
-API_JSON=$(printf '{"tag_name": "v%s", "target_commitish": "release", "name": "v%s", "body": "Release of version %s", "draft": false, "prerelease": false}' $VERSION $VERSION $VERSION)
+API_JSON=$(printf '{"tag_name": "v%s", "target_commitish": "release", "name": "v%s", "body": "%s", "draft": false, "prerelease": false}' $VERSION $VERSION $CHANGELOG)
 curl \
   --data "$API_JSON" \
   -H "Authorization: token ${GITHUB_TOKEN}" \

Diff for: package.json

@@ -32,6 +32,8 @@
   "types": "./index.d.ts",
   "license": "MIT",
   "devDependencies": {
+    "@types/grunt": "^0.4.21",
+    "conventional-changelog": "^1.1.0",
     "grunt": "^1.0.1",
     "grunt-banner": "^0.6.0",
     "grunt-browserify": "^5.0.0",