chore: Support changeset type shorthands via shared source of truth

Author: emincihangeri

.github/actions/check-pr/index.js

@@ -0,0 +1,35 @@
+/* eslint-disable jsdoc/require-jsdoc */
+export const messageTypes = [
+  {
+    name: 'compat',
+    title: 'Compatibility Notes',
+    alternatives: ['compatibility', 'compatibility note', 'compat']
+  },
+  {
+    name: 'feat',
+    title: 'New Features',
+    alternatives: ['new', 'new functionality', 'feat']
+  },
+  {
+    name: 'fix',
+    title: 'Fixed Issues',
+    alternatives: ['bug', 'bug fix', 'fixed issue', 'fix', 'fix issue']
+  },
+  {
+    name: 'known-issue',
+    title: 'Known Issues',
+    alternatives: ['known issue']
+  },
+  {
+    name: 'impr',
+    title: 'Improvements',
+    alternatives: ['improvement', 'improv']
+  },
+  {
+    name: 'dep',
+    title: 'Updated Dependencies',
+    alternatives: ['dependency', 'dependency update']
+  }
+];
+
+export type MessageType = (typeof messageTypes)[number];

.github/actions/merge-and-write-changelogs/index.js

@@ -7,7 +7,7 @@
   "type": "module",
   "scripts": {
     "compile": "tsc -p tsconfig.json",
-    "postcompile": "ncc build lib/index.js --out ../../.github/actions/check-pr/",
+    "postcompile": "ncc build lib/check-pr/index.js --out ../../.github/actions/check-pr/",
     "test": "pnpm run test:unit",
     "test:unit": "NODE_OPTIONS=--experimental-vm-modules pnpm exec jest",
     "lint": "eslint --ignore-pattern '!index.ts' && prettier --check **/*.ts",

build-packages/changeset-types.ts

@@ -7,6 +7,7 @@
     "strict": true,
     "skipLibCheck": true,
     "isolatedModules": true,
+    "rootDir": "..",
     "outDir": "./lib",
     "tsBuildInfoFile": "./lib/.tsbuildinfo"
   },

build-packages/check-pr/package.json

@@ -124,14 +124,32 @@ describe('check-pr', () => {
     it('should fail if change type is wrong', async () => {
       const fileContents = [
         "'@sap-cloud-sdk/generator': major",
-        '[Fix] Something is fixed.'
+        '[Something] Something is fixed.'
       ];
       validateChangesets('chore!', '', true, fileContents);
       expect(setFailed).toHaveBeenCalledWith(
-        "All change types must match one of the allowed change types '[Known Issue]' or '[Compatibility Note]' or '[New Functionality]' or '[Improvement]' or '[Fixed Issue]'."
+        "All change types must be one of: 'compat', 'feat', 'fix', 'known-issue', 'impr', 'dep' (or their aliases)."
       );
     });
 
+    it('should pass if shorthand change type is provided', async () => {
+      const fileContents = [
+        "'@sap-cloud-sdk/generator': major",
+        '[fix] Something is fixed.'
+      ];
+      validateChangesets('chore!', '', true, fileContents);
+      expect(setFailed).not.toHaveBeenCalled();
+    });
+
+    it('should pass if compat shorthand change type is provided', async () => {
+      const fileContents = [
+        "'@sap-cloud-sdk/generator': major",
+        '[compat] Something changed.'
+      ];
+      validateChangesets('chore!', '', true, fileContents);
+      expect(setFailed).not.toHaveBeenCalled();
+    });
+
     it('should pass if correct change type is provided', async () => {
       const fileContents = [
         "'@sap-cloud-sdk/generator': major",

build-packages/check-pr/tsconfig.json

@@ -2,6 +2,7 @@
 import { readFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { getInput, setFailed, info } from '@actions/core';
+import { messageTypes } from '../changeset-types.js';
 
 const validCommitTypes = ['feat', 'fix', 'chore'];
 
@@ -115,13 +116,10 @@ export function validateChangesets(
   fileContents: string[]
 ): void {
   const allowedBumps = getAllowedBumps(commitType, isBreaking);
-  const allowedChangeTypes = [
-    'Known Issue',
-    'Compatibility Note',
-    'New Functionality',
-    'Improvement',
-    'Fixed Issue'
-  ];
+  const allAllowedTypes = messageTypes.flatMap(({ name, alternatives }) => [
+    name,
+    ...alternatives
+  ]);
 
   if (!hasMatchingChangeset(allowedBumps, fileContents)) {
     return setFailed(
@@ -141,14 +139,12 @@ export function validateChangesets(
   }
 
   const allChangeTypesMatch = changeTypes.every(type =>
-    allowedChangeTypes.includes(type)
+    allAllowedTypes.includes(type.toLowerCase())
   );
 
   if (!allChangeTypesMatch) {
     return setFailed(
-      `All change types must match one of the allowed change types ${allowedChangeTypes
-        .map(type => `'[${type}]'`)
-        .join(' or ')}.`
+      `All change types must be one of: ${messageTypes.map(({ name }) => `'${name}'`).join(', ')} (or their aliases).`
     );
   }
 

build-packages/check-pr/validators.spec.ts

@@ -3,36 +3,7 @@ import { readFile, writeFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { setFailed, info } from '@actions/core';
 import { getPackages } from '@manypkg/get-packages';
-
-const messageTypes = [
-  {
-    name: 'compat',
-    title: 'Compatibility Notes',
-    alternatives: ['compatibility', 'compatibility note', 'compat']
-  },
-  {
-    name: 'feat',
-    title: 'New Features',
-    alternatives: ['new', 'new functionality', 'feat']
-  },
-  {
-    name: 'fix',
-    title: 'Fixed Issues',
-    alternatives: ['bug', 'bug fix', 'fixed issue', 'fix', 'fix issue']
-  },
-  {
-    name: 'impr',
-    title: 'Improvements',
-    alternatives: ['improvement', 'improv']
-  },
-  {
-    name: 'dep',
-    title: 'Updated Dependencies',
-    alternatives: ['dependency', 'dependency update']
-  }
-];
-
-type MessageType = (typeof messageTypes)[number];
+import { messageTypes, type MessageType } from '../changeset-types.js';
 
 interface Change {
   packageNames: string[];

build-packages/check-pr/validators.ts

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}