ci: add automatic changelog generation

.gitlab-ci.yml

@@ -74,6 +74,20 @@ publish-artifacts:
     rules:
         - if: '$CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.[0-9]+$/'
 
+changelog:
+    stage: publish
+    before_script:
+        - yarn install --immutable
+    script:
+        - yarn changelog
+    cache:
+        <<: *global_cache
+    artifacts:
+        paths:
+            - CHANGELOG.md
+    rules:
+        - if: '$CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.[0-9]+$/'
+
 .release-template: &release-template
     stage: release
     before_script:
@@ -125,7 +139,7 @@ release:
         - if: '$CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.[0-9]+$/'
     release:
         tag_name: $CI_COMMIT_TAG
-        description: "# Changelog"
+        description: "./CHANGELOG.md"
         assets:
             links:
                 - name: "ds4.zip"

.husky/commit-msg

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# SPDX-FileCopyrightText: 2021 Johannes Loher
+#
+# SPDX-License-Identifier: MIT
+
+. "$(dirname "$0")/_/husky.sh"
+
+yarn run commitlint --edit "$1"

changelog.config.js

@@ -0,0 +1,7 @@
+// SPDX-FileCopyrightText: 2021 Johannes Loher
+//
+// SPDX-License-Identifier: MIT
+
+const config = require("conventional-changelog-conventionalcommits");
+
+module.exports = config();

commitlint.config.js

@@ -0,0 +1,5 @@
+// SPDX-FileCopyrightText: 2021 Johannes Loher
+//
+// SPDX-License-Identifier: MIT
+
+module.exports = { extends: ["@commitlint/config-conventional"] };

package.json

@@ -50,15 +50,20 @@
         "test:ci": "jest --ci --reporters=default --reporters=jest-junit",
         "format": "prettier --write \"./**/*.(ts|js|json|scss)\"",
         "typecheck": "tsc --noEmit",
-        "postinstall": "husky install"
+        "postinstall": "husky install",
+        "changelog": "conventional-changelog -n changelog.config.js -o CHANGELOG.md"
     },
     "devDependencies": {
+        "@commitlint/cli": "13.1.0",
+        "@commitlint/config-conventional": "13.1.0",
         "@league-of-foundry-developers/foundry-vtt-types": "0.8.8-9",
         "@types/fs-extra": "9.0.12",
         "@types/jest": "27.0.1",
         "@typescript-eslint/eslint-plugin": "4.31.1",
         "@typescript-eslint/parser": "4.31.1",
         "chalk": "4.1.2",
+        "conventional-changelog-cli": "2.1.1",
+        "conventional-changelog-conventionalcommits": "4.6.1",
         "eslint": "7.32.0",
         "eslint-config-prettier": "8.3.0",
         "eslint-plugin-jest": "24.4.0",