Merge pull request #7687 from dibarbet/update_changelog_in_snap

Create new section in changelog when updating version

Author: dibarbet

.github/workflows/branch-snap.yml

@@ -25,8 +25,8 @@ jobs:
       - name: Install dependencies 
         run: npm ci
       - name: Update version.json
-        run: npx gulp incrementVersionJson
-      - name: Create version.json update PR
+        run: npx gulp incrementVersion
+      - name: Create version update PR
         uses: peter-evans/create-pull-request@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -3,7 +3,7 @@
 - Diagnostics related feature requests and improvements [#5951](https://github.com/dotnet/vscode-csharp/issues/5951)
 - Debug from .csproj and .sln [#5876](https://github.com/dotnet/vscode-csharp/issues/5876)
 
-# Latest
+# 2.54.x
 * Update Roslyn to 4.13.0-1.24525.2 (PR: [#7694](https://github.com/dotnet/vscode-csharp/pull/7694))
   * Fix error message spelling (PR: [#75601](https://github.com/dotnet/roslyn/pull/75601))
   * Improve diagnostic performance by re-using results if diagnostic data is the same (PR: [#75587](https://github.com/dotnet/roslyn/pull/75587))

tasks/snapTasks.ts

@@ -6,21 +6,61 @@
 import * as gulp from 'gulp';
 import * as fs from 'fs';
 import * as path from 'path';
+import * as os from 'os';
 
-gulp.task('incrementVersionJson', async (): Promise<void> => {
+gulp.task('incrementVersion', async (): Promise<void> => {
+    // Get the current version from version.json
     const versionFilePath = path.join(path.resolve(__dirname, '..'), 'version.json');
     const file = fs.readFileSync(versionFilePath, 'utf8');
     const versionJson = JSON.parse(file);
 
+    // Increment the minor version
     const version = versionJson.version as string;
     const split = version.split('.');
     const newVersion = `${split[0]}.${parseInt(split[1]) + 1}`;
 
     console.log(`Updating ${version} to ${newVersion}`);
 
+    // Write the new version back to version.json
     versionJson.version = newVersion;
     const newJson = JSON.stringify(versionJson, null, 4);
     console.log(`New json: ${newJson}`);
 
     fs.writeFileSync(versionFilePath, newJson);
+
+    // Add a new changelog section for the new version.
+    console.log('Adding new version header to changelog');
+
+    const changelogPath = path.join(path.resolve(__dirname, '..'), 'CHANGELOG.md');
+    const changelogContent = fs.readFileSync(changelogPath, 'utf8');
+    const changelogLines = changelogContent.split(os.EOL);
+
+    // Find all the headers in the changelog (and their line numbers)
+    const headerRegex = /^#+\s+.*$/gm;
+    const matches = [];
+    for (let i = 0; i < changelogLines.length; i++) {
+        const line = changelogLines.at(i);
+        const match = headerRegex.exec(line!);
+        if (match) {
+            matches.push({ line: i, text: match[0] });
+        }
+    }
+
+    // Find the known issues header, then find the next header after it.
+    const knownIssuesHeader = matches.find((m) => m.text.includes('Known Issues'));
+    if (knownIssuesHeader === undefined) {
+        throw new Error('Could not find the known issues header in the changelog.');
+    }
+    const knownIssuesIndex = matches.indexOf(knownIssuesHeader);
+    if (knownIssuesIndex === -1) {
+        throw new Error('Could not find the known issues index in the matches.');
+    }
+
+    // Insert a new header for the new version after the known issues header but before the next header.
+    const lineToInsertAt = matches[knownIssuesIndex + 1].line - 1;
+    console.log(`Inserting new version header at line ${lineToInsertAt}`);
+    const linesToInsert = ['', `# ${newVersion}.x`];
+
+    changelogLines.splice(lineToInsertAt, 0, ...linesToInsert);
+    fs.writeFileSync(changelogPath, changelogLines.join(os.EOL));
 });