Dump git-log to change-log

.github/workflows/nodejs.yml

@@ -28,3 +28,9 @@ jobs:
           git diff --exit-code vocabularies
         env:
           CI: true
+      - name: write changelog
+        if: ${{ github.event.pull_request.merged == true }}
+        run: npm run changelog
+        env:
+          CI: true
+          PUSHER_EMAIL: ${{ github.event.pusher.email }}

lib/changelog.js

@@ -0,0 +1,58 @@
+const {Transform} = require("stream");
+
+var entry;
+var blocked = new Map();
+
+function nextLine(t) {
+	var offset = t.buffer.indexOf("\n");
+	if (offset >= 0) {
+		var o = offset;
+		if (t.buffer[o - 1] === 13) o--;  // drop carriage-return before line-feed
+		t.emit("line", t.buffer.toString("utf8", 0, o));
+		t.buffer = t.buffer.slice(offset + 1);
+		process.nextTick(nextLine, t);
+	} else
+		t.callback();
+}
+
+process.stdin.pipe(
+	new Transform({
+		transform(chunk, encoding, callback) {
+			this.buffer = this.buffer ?
+				Buffer.concat([this.buffer, chunk], this.buffer.length + chunk.length) :
+				Buffer.from(chunk);
+			this.callback = callback;
+			nextLine(this);
+		},
+		flush(callback) {
+			if (this.buffer && this.buffer.length > 0)  // add line-feed to final line
+				this._transform(Buffer.from("\n"), undefined, callback);
+			else
+				callback();
+		}
+	})
+	.on("line", function(line) {
+		if (/^commit\s+([0-9a-f]*)/.test(line)) {
+			if (entry && entry.length > 2) this.push(entry.join(""));
+			if (blocked.get(RegExp.$1)) entry = undefined;
+			else entry = [];
+		} else if (entry && /^Date:\s+(.*)$/.test(line))
+			entry.push("# " + RegExp.$1 + "\n");
+		else if (entry && /^\s+\S/.test(line)) {
+			if (entry.length === 1)
+				entry.push("");
+			else if (entry.length === 2) {
+				if (!/^\s+CHANGELOG(\s+([0-9a-f]*))?\s*$/.test(line))
+					entry = undefined;
+				else {
+					blocked.set(RegExp.$2, true);
+					entry.push("");
+				}
+			} else
+				entry.push(line.replace(/^\s*/, "") + "\n");
+		}
+	})
+	.on("end", function() {
+		if (entry && entry.length > 2) process.stdout.write(entry.join(""));
+	})
+).pipe(process.stdout);

lib/changelog.sh

@@ -0,0 +1,13 @@
+remote=$(git remote show origin | grep -P -o "(?<=Push  URL: ).*")
+folder=$(mktemp -d)
+git log | node lib/changelog >$folder/CHANGELOG.md
+cd $folder
+git init -b main
+git add .
+git commit -m "changelog"
+git push --force $remote main:changelog
+
+# Alternative
+# git log | node lib/changelog >$folder/CHANGELOG.md
+# git diff-index --quiet HEAD || git commit -m "changelog"
+# git push

package.json

@@ -26,6 +26,7 @@
   },
   "scripts": {
     "build": "node lib/transform.js",
+    "changelog": "./lib/changelog.sh",
     "test": "c8 -r html -r text mocha",
     "watch": "mocha --watch"
   },

test/changelog.test.js

@@ -0,0 +1,26 @@
+const assert = require("assert");
+const { spawn } = require("child_process");
+const fs = require("fs");
+
+describe("Changelog", function () {
+  it("Convert git log to changelog", function () {
+    var markdown = "";
+    var proc = spawn("node", ["lib/changelog"], { cwd: __dirname + "/.." });
+    proc.stdout
+      .on("data", function (chunk) {
+        markdown += chunk;
+      })
+      .on("end", function () {
+        assert.deepStrictEqual(markdown.split("\n"), [
+          "# Thu Sep 16 17:19:02 2021 +0200",
+          "- All terms were deprecated",
+          "- 100 new terms were introduced",
+          "# Thu Sep 16 17:19:01 2021 +0200",
+          "New vocabulary",
+          "",
+        ]);
+        process.exit(0);
+      });
+    fs.createReadStream("test/gitlog.txt").pipe(proc.stdin);
+  });
+});

test/gitlog.txt

@@ -0,0 +1,44 @@
+commit 0c620c74d1c738e98f270c809ea6f347d5106e7c
+Author: Ralf Handl <[email protected]>
+Date:   Fri Sep 17 11:00:09 2021 +0200
+
+    Update README.md (#155)
+
+    * Update README.md
+
+    Co-authored-by: Heiko Theißen <[email protected]>
+
+commit 122dff83ef4f139e3361e5af557519c898ee81bd
+Author: Ralf Handl <[email protected]>
+Date:   Thu Sep 16 17:19:02 2021 +0200
+
+     Temporal: example for timeline with object key (#154)
+
+    CHANGELOG
+    - All terms were deprecated
+    - 100 new terms were introduced
+
+commit c231de3dbb043eae0deed124851055712da6ff59
+Author: Heiko Theißen <[email protected]>
+Date:   Thu Sep 16 17:24:48 2021 +0200
+
+    Temporal vocabulary (#146)
+
+commit 122dff93ef4f139e3361e5af557519c898ee81bd
+Author: Ralf Handl <[email protected]>
+Date:   Thu Sep 16 17:19:01 2021 +0200
+
+     Temporal: example for timeline with object key (#154)
+
+    CHANGELOG 122dff73ef4f139e3361e5af557519c898ee81bd
+    New vocabulary
+
+commit 122dff73ef4f139e3361e5af557519c898ee81bd
+Author: Ralf Handl <[email protected]>
+Date:   Thu Sep 16 17:19:01 2021 +0200
+
+     Temporal: example for timeline with object key (#154)
+
+    CHANGELOG
+    New vocabularie
+