gh-setup-git-identity 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # gh-setup-git-identity
 
+## 0.3.1
+
+### Patch Changes
+
+- 51dceeb: Fix release notes formatting to support Major and Minor changes
+
+  Previously, the format-release-notes.mjs script only looked for "### Patch Changes" sections in release notes. This caused releases with Minor or Major changes (like v0.3.0) to not be properly formatted with PR links and npm badges.
+
+  Updated the regex pattern to handle all three change types (Major, Minor, and Patch), matching the release template from test-anywhere repository.
+
 ## 0.3.0
 
 ### Minor Changes

package/experiments/test-release-regex.mjs

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+
+/**
+ * Test script to verify the release notes regex pattern
+ * works correctly for Major, Minor, and Patch changes
+ */
+
+// Test cases representing different release note formats
+const testCases = [
+  {
+    name: 'Minor Changes with commit hash',
+    body: `### Minor Changes
+
+- 8c146cc: Automatically run \`gh auth login\` when GitHub CLI is not authenticated, enabling single-command setup instead of requiring manual login first`,
+    expectedType: 'Minor',
+    expectedHash: '8c146cc',
+    expectedDesc: 'Automatically run `gh auth login` when GitHub CLI is not authenticated, enabling single-command setup instead of requiring manual login first',
+  },
+  {
+    name: 'Patch Changes with commit hash',
+    body: `### Patch Changes
+
+- abc1234: Fix a bug in the login flow`,
+    expectedType: 'Patch',
+    expectedHash: 'abc1234',
+    expectedDesc: 'Fix a bug in the login flow',
+  },
+  {
+    name: 'Major Changes with commit hash',
+    body: `### Major Changes
+
+- deadbeef: Breaking change - new API`,
+    expectedType: 'Major',
+    expectedHash: 'deadbeef',
+    expectedDesc: 'Breaking change - new API',
+  },
+  {
+    name: 'Minor Changes without commit hash',
+    body: `### Minor Changes
+
+- Add new feature`,
+    expectedType: 'Minor',
+    expectedHash: null,
+    expectedDesc: 'Add new feature',
+  },
+];
+
+// The regex pattern from the updated format-release-notes.mjs
+const changesPattern =
+  /### (Major|Minor|Patch) Changes\s*\n\s*-\s+(?:([a-f0-9]+):\s+)?(.+?)$/s;
+
+console.log('Testing release notes regex pattern\n');
+console.log('='.repeat(60));
+
+let passed = 0;
+let failed = 0;
+
+for (const testCase of testCases) {
+  console.log(`\nTest: ${testCase.name}`);
+  console.log('-'.repeat(40));
+
+  const match = testCase.body.match(changesPattern);
+
+  if (!match) {
+    console.log('❌ FAILED: No match found');
+    failed++;
+    continue;
+  }
+
+  const [, changeType, commitHash, rawDescription] = match;
+
+  let allPassed = true;
+
+  if (changeType !== testCase.expectedType) {
+    console.log(`❌ changeType: expected '${testCase.expectedType}', got '${changeType}'`);
+    allPassed = false;
+  } else {
+    console.log(`✅ changeType: ${changeType}`);
+  }
+
+  const expectedHash = testCase.expectedHash || null;
+  const actualHash = commitHash || null;
+  if (actualHash !== expectedHash) {
+    console.log(`❌ commitHash: expected '${expectedHash}', got '${actualHash}'`);
+    allPassed = false;
+  } else {
+    console.log(`✅ commitHash: ${actualHash}`);
+  }
+
+  if (rawDescription !== testCase.expectedDesc) {
+    console.log(`❌ description: expected '${testCase.expectedDesc}', got '${rawDescription}'`);
+    allPassed = false;
+  } else {
+    console.log(`✅ description: ${rawDescription.substring(0, 50)}...`);
+  }
+
+  if (allPassed) {
+    passed++;
+    console.log('✅ TEST PASSED');
+  } else {
+    failed++;
+    console.log('❌ TEST FAILED');
+  }
+}
+
+console.log('\n' + '='.repeat(60));
+console.log(`\nResults: ${passed} passed, ${failed} failed`);
+
+if (failed > 0) {
+  process.exit(1);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-setup-git-identity",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A tool to setup git identity based on current gh user",
   "type": "module",
   "main": "src/index.js",

package/scripts/format-release-notes.mjs

@@ -86,28 +86,32 @@ try {
     process.exit(0);
   }
 
-  // Extract the patch changes section
-  // This regex handles two formats:
-  // 1. With commit hash: "- abc1234: Description"
-  // 2. Without commit hash: "- Description"
-  const patchChangesMatchWithHash = currentBody.match(
-    /### Patch Changes\s*\n\s*-\s+([a-f0-9]+):\s+(.+?)$/s
-  );
-  const patchChangesMatchNoHash = currentBody.match(
-    /### Patch Changes\s*\n\s*-\s+(.+?)$/s
-  );
+  // Extract the changes section (Major, Minor, or Patch)
+  // This regex handles formats:
+  // 1. With commit hash: "### Major Changes\n- abc1234: Description"
+  // 2. Without commit hash: "### Minor Changes\n- Description"
+  const changesPattern =
+    /### (Major|Minor|Patch) Changes\s*\n\s*-\s+(?:([a-f0-9]+):\s+)?(.+?)$/s;
+  const changesMatch = currentBody.match(changesPattern);
 
   let commitHash = null;
   let rawDescription = null;
+  let changeType = null;
+
+  if (changesMatch) {
+    [, changeType, commitHash, rawDescription] = changesMatch;
+    console.log(`Found ${changeType} Changes section`);
 
-  if (patchChangesMatchWithHash) {
-    // Format: - abc1234: Description
-    [, commitHash, rawDescription] = patchChangesMatchWithHash;
-  } else if (patchChangesMatchNoHash) {
-    // Format: - Description (no commit hash)
-    [, rawDescription] = patchChangesMatchNoHash;
+    // Extract commit hash if embedded in description (fallback)
+    if (!commitHash && rawDescription) {
+      const descWithHashMatch = rawDescription.match(/^([a-f0-9]+):\s+(.+)$/s);
+      if (descWithHashMatch) {
+        [, commitHash, rawDescription] = descWithHashMatch;
+      }
+    }
   } else {
-    console.log('Could not parse patch changes from release notes');
+    console.log('Could not parse changes from release notes');
+    console.log('   Looking for pattern: ### [Major|Minor|Patch] Changes');
     process.exit(0);
   }