ci: conventional commits changelog (#3843)

* feat(live-preview): another oen

* wip: changelog script

* wippppp

* chore: this worked

* wip: changelog working

* chore(script): working changelog gen

* chore(script): update changelog during release

Author: denolfe

changelog.config.js

@@ -0,0 +1,39 @@
+module.exports = {
+  // gitRawCommitsOpts: {
+  //   from: 'v2.0.9',
+  //   path: 'packages/payload',
+  // },
+  // infile: 'CHANGELOG.md',
+  options: {
+    preset: {
+      name: 'conventionalcommits',
+      types: [
+        { section: 'Features', type: 'feat' },
+        { section: 'Features', type: 'feature' },
+        { section: 'Bug Fixes', type: 'fix' },
+        { section: 'Documentation', type: 'docs' },
+      ],
+    },
+  },
+  // outfile: 'NEW.md',
+  writerOpts: {
+    commitGroupsSort: (a, b) => {
+      const groupOrder = ['Features', 'Bug Fixes', 'Documentation']
+      return groupOrder.indexOf(a.title) - groupOrder.indexOf(b.title)
+    },
+
+    // Scoped commits at the end, alphabetical sort
+    commitsSort: (a, b) => {
+      if (a.scope || b.scope) {
+        if (!a.scope) return -1
+        if (!b.scope) return 1
+        return a.scope === b.scope
+          ? a.subject.localeCompare(b.subject)
+          : a.scope.localeCompare(b.scope)
+      }
+
+      // Alphabetical sort
+      return a.subject.localeCompare(b.subject)
+    },
+  },
+}

package.json

@@ -40,6 +40,10 @@
     "@swc/register": "0.1.10",
     "@testing-library/jest-dom": "5.17.0",
     "@testing-library/react": "13.4.0",
+    "@types/concat-stream": "^2.0.1",
+    "@types/conventional-changelog": "^3.1.4",
+    "@types/conventional-changelog-core": "^4.2.5",
+    "@types/conventional-changelog-preset-loader": "^2.3.4",
     "@types/fs-extra": "^11.0.2",
     "@types/jest": "29.5.4",
     "@types/minimist": "1.2.2",
@@ -50,15 +54,21 @@
     "@types/semver": "^7.5.3",
     "@types/shelljs": "0.8.12",
     "@types/testing-library__jest-dom": "5.14.8",
+    "add-stream": "^1.0.0",
     "chalk": "^5.3.0",
     "chalk-template": "1.1.0",
+    "concat-stream": "^2.0.0",
+    "conventional-changelog": "^5.1.0",
+    "conventional-changelog-core": "^7.0.0",
+    "conventional-changelog-preset-loader": "^4.1.0",
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
     "dotenv": "8.6.0",
     "express": "4.18.2",
     "form-data": "3.0.1",
     "fs-extra": "10.1.0",
     "get-port": "5.1.1",
+    "get-stream": "6.0.1",
     "glob": "8.1.0",
     "graphql-request": "6.1.0",
     "husky": "^8.0.3",
@@ -74,12 +84,14 @@
     "prettier": "^3.0.3",
     "prompts": "2.4.2",
     "qs": "6.11.2",
+    "read-stream": "^2.1.1",
     "rimraf": "3.0.2",
     "semver": "^7.5.4",
     "shelljs": "0.8.5",
     "simple-git": "^3.20.0",
     "slash": "3.0.0",
     "slate": "0.91.4",
+    "tempfile": "^3.0.0",
     "ts-node": "10.9.1",
     "tsx": "^3.13.0",
     "turbo": "^1.10.15",