Refactoring automated changelog generation

Author: Fabiana Severin

.github/workflows/build-and-release.yml

@@ -152,11 +152,23 @@ jobs:
     #   env:
     #     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-    - name: Generate Changelog
+    - name: Generate and Update Changelog
       run: |
-        node scripts/generate-changelog.js --output changelog.md
-        echo "Generated changelog:"
-        cat changelog.md
+        # Generate changelog entry for this release
+        node scripts/generate-changelog.js --output release-notes.md
+        
+        # Update RELEASE.CHANGELOG.md with the new entry
+        node scripts/generate-changelog.js --update
+        
+        # Commit the updated changelog
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add RELEASE.CHANGELOG.md
+        git commit -m "Update changelog for ${{ steps.version.outputs.package_version }}" || echo "No changes to commit"
+        
+        # Show the generated release notes
+        echo "Generated release notes:"
+        cat release-notes.md
 
     - name: Create GitHub Release
       uses: softprops/action-gh-release@v2
@@ -168,7 +180,7 @@ jobs:
           checksums.txt
         prerelease: ${{ steps.version.outputs.is_rc }}
         name: ${{ steps.version.outputs.is_rc == 'true' && format('Release Candidate {0}', steps.version.outputs.package_version) || '' }}
-        body_path: changelog.md
+        body_path: release-notes.md
 
   test-publish:
     if: (github.event_name == 'workflow_dispatch' && github.event.inputs.test_mode != 'none') || github.ref == 'refs/heads/fabisev/artifact-publishing'

README.md

@@ -173,16 +173,16 @@ When modifying dependencies (`package.json`), make sure to:
 We require package-lock.json to be checked in to ensure consistent installations across development environments.
 
 ### Changelog Generation
-This project includes an automated changelog generator that creates a list of commits between tags when a new release is created. The changelog is automatically included in GitHub release notes.
+This project maintains a changelog in `RELEASE.CHANGELOG.md`. The changelog is automatically updated when a new tag is created.
 
-To manually generate a changelog:
+To manually generate a changelog entry for testing or preview purposes, run:
 ```shell script
 npm run changelog
 ```
 
-You can also specify custom options:
+To manually update the RELEASE.CHANGELOG.md file with a new entry:
 ```shell script
-npm run changelog -- --start-ref v1.0.0 --end-ref HEAD --output CHANGELOG.md
+npm run changelog -- --update
 ```
 
 ### Copyright Headers

package.json

@@ -8,6 +8,7 @@
   "scripts": {
     "archive": "npx rimraf aws-lambda-ric-*.tgz && npm install && npm run build && npm pack",
     "changelog": "node ./scripts/generate-changelog.js",
+    "changelog:update": "node ./scripts/generate-changelog.js --update",
     "clean": "npx rimraf build node_modules package-lock.json",
     "copy-files": "mkdir -p dist && cp src/types/* dist/",
     "update-deps": "./scripts/update_dependencies.sh",

scripts/generate-changelog.js

@@ -9,60 +9,41 @@ const fs = require('fs');
 const path = require('path');
 
 /**
- * Simple changelog generator that creates a markdown formatted list of commits
- * between the last tag and HEAD (or between two specified git refs)
+ * Script to generate and update changelog entries in RELEASE.CHANGELOG.md
+ * It automatically adds new entries when cutting a new tag
  */
 
 // Parse command line arguments
 const args = process.argv.slice(2);
-let startRef = '';
-let endRef = 'HEAD';
-let outputFile = '';
+const updateFile = args.includes('--update');
+const outputFile = args.find((arg, i) => arg === '--output' && i + 1 < args.length) 
+  ? args[args.indexOf('--output') + 1] 
+  : null;
 
-// Process arguments
-for (let i = 0; i < args.length; i++) {
-  if (args[i] === '--start-ref' && i + 1 < args.length) {
-    startRef = args[i + 1];
-    i++;
-  } else if (args[i] === '--end-ref' && i + 1 < args.length) {
-    endRef = args[i + 1];
-    i++;
-  } else if (args[i] === '--output' && i + 1 < args.length) {
-    outputFile = args[i + 1];
-    i++;
-  }
-}
-
-// If no start ref is provided, use the last tag
-if (!startRef) {
-  try {
-    startRef = execSync('git describe --tags --abbrev=0').toString().trim();
-    console.log(`Using last tag as start ref: ${startRef}`);
-  } catch (error) {
-    console.error('No tags found. Using first commit as start ref.');
-    startRef = execSync('git rev-list --max-parents=0 HEAD').toString().trim();
-  }
+// Get the last tag
+let lastTag;
+try {
+  lastTag = execSync('git describe --tags --abbrev=0').toString().trim();
+  console.log(`Last tag: ${lastTag}`);
+} catch (error) {
+  console.error('No tags found.');
+  process.exit(1);
 }
 
-// Get repository info from package.json
+// Get current version from package.json
 const packageJson = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8'));
-const repoUrl = packageJson.repository && packageJson.repository.url
-  ? packageJson.repository.url.replace(/^git\+|\.git$/g, '')
-  : 'https://github.com/aws/aws-lambda-nodejs-runtime-interface-client';
-
-// Get commit range
-const commitRange = `${startRef}..${endRef}`;
-console.log(`Generating changelog for commit range: ${commitRange}`);
+const version = packageJson.version;
+console.log(`Current version: ${version}`);
 
-// Get commits
+// Get commits since last tag
 const gitLogFormat = '%h %s';
-const gitLog = execSync(`git log ${commitRange} --pretty=format:"${gitLogFormat}"`).toString();
+const gitLog = execSync(`git log ${lastTag}..HEAD --pretty=format:"${gitLogFormat}"`).toString();
 
-// Filter out version commits and format the changelog
+// Filter and format commits
 const commits = gitLog.split('\n')
   .filter(line => line.trim())
   .filter(line => {
-    // Filter out version commits (just a version number)
+    // Filter out version commits
     const message = line.substring(line.indexOf(' ') + 1);
     return !/^v?\d+\.\d+\.\d+(-.*)?$/.test(message) && 
            !message.startsWith('working on ') &&
@@ -72,25 +53,45 @@ const commits = gitLog.split('\n')
     const hash = line.substring(0, line.indexOf(' '));
     const message = line.substring(line.indexOf(' ') + 1);
 
-    // Check if message starts with a category (e.g., "feat:", "fix:")
-    let formattedMessage = message;
-    const categoryMatch = message.match(/^(\w+):\s*(.*)/);
-    if (categoryMatch) {
-      const [, category, rest] = categoryMatch;
-      formattedMessage = `**${category}**: ${rest}`;
-    }
+    // Check for PR number in message
+    const prMatch = message.match(/\(#(\d+)\)|\(https:\/\/github\.com\/[^\/]+\/[^\/]+\/pull\/(\d+)\)/);
+    const prNumber = prMatch ? prMatch[1] || prMatch[2] : null;
 
-    return `* [\`${hash}\`](${repoUrl}/commit/${hash}) - ${formattedMessage}`;
+    if (prNumber) {
+      return `- ${message} ([#${prNumber}](https://github.com/aws/aws-lambda-nodejs-runtime-interface-client/pull/${prNumber}))`;
+    } else {
+      return `- ${message}`;
+    }
   });
 
-// Generate the changelog content
-const changelogContent = commits.join('\n');
+// Generate changelog entry
+const today = new Date();
+const formattedDate = `${today.toLocaleString('en-US', { month: 'short' })} ${today.getDate()}, ${today.getFullYear()}`;
+
+const changelogEntry = `### ${formattedDate}
+\`${version}\`
+${commits.join('\n')}
+
+`;
 
-// Output the changelog
+// Output the changelog entry
 if (outputFile) {
-  fs.writeFileSync(outputFile, changelogContent);
-  console.log(`Changelog written to ${outputFile}`);
+  fs.writeFileSync(outputFile, changelogEntry);
+  console.log(`Changelog entry written to ${outputFile}`);
 } else {
-  console.log('\nChangelog:');
-  console.log(changelogContent);
+  console.log('\nChangelog entry:');
+  console.log(changelogEntry);
+}
+
+// Update RELEASE.CHANGELOG.md if requested
+if (updateFile) {
+  const changelogPath = path.join(process.cwd(), 'RELEASE.CHANGELOG.md');
+  if (fs.existsSync(changelogPath)) {
+    const existingChangelog = fs.readFileSync(changelogPath, 'utf8');
+    fs.writeFileSync(changelogPath, changelogEntry + existingChangelog);
+    console.log(`Updated ${changelogPath} with new entry`);
+  } else {
+    fs.writeFileSync(changelogPath, changelogEntry);
+    console.log(`Created ${changelogPath} with new entry`);
+  }
 }