Merge branch 'main' into dev/rigibson/integration-test-restore

Author: RikkiGibson

.github/workflows/branch-snap.yml

@@ -1,6 +1,12 @@
 name: Branch snap
 on:
-  workflow_dispatch
+  workflow_dispatch:
+    inputs:
+      releaseCandidate:
+        description: 'Is this a release candidate snap from main? (Will increment main version to be higher than next stable release)'
+        required: false
+        default: 'false'
+        type: boolean
 
 permissions:
   contents: write
@@ -18,19 +24,50 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install NodeJS
         uses: actions/setup-node@v4
         with:
           node-version: '18.x'
       - name: Install dependencies 
         run: npm ci
       - name: Update version.json
-        run: npx gulp incrementVersion
+        run: |
+          if [ "${{ github.event.inputs.releaseCandidate }}" = "true" ]; then
+            npx gulp incrementVersion --releaseCandidate=true
+          else
+            npx gulp incrementVersion
+          fi
       - name: Create version update PR
         uses: peter-evans/create-pull-request@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: Update main version
           title: '[automated] Update main version'
           branch: merge/update-main-version
+
+  update-release-version:
+    needs: check-script
+    if: github.ref == 'refs/heads/prerelease'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out merge branch
+        uses: actions/checkout@v4
+        with:
+          ref: merge/prerelease-to-release
+          fetch-depth: 0
+      - name: Install NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18.x'
+      - name: Install dependencies 
+        run: npm ci
+      - name: Update version.json for release
+        run: npx gulp updateVersionForStableRelease
+      - name: Create PR with version update
+        uses: peter-evans/create-pull-request@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update version for stable release
+          branch: merge/prerelease-to-release
+          base: release

CONTRIBUTING.md

@@ -196,15 +196,25 @@ More details for this are [here] (https://devdiv.visualstudio.com/DevDiv/_git/Vi
 ## Snapping for releases
 Extension releases on the marketplace are done from the prerelease and release branches (corresponding to the prerelease or release version of the extension).  Code flows from main -> prerelease -> release.  Every week we snap main -> prerelease.  Monthly, we snap prerelease -> release.
 
+### Versioning Scheme
+The extension follows a specific versioning scheme for releases:
+- **Prerelease versions**: Use standard minor version increments (e.g., 2.74, 2.75, 2.76...)
+- **Stable release versions**: Use the next tens version (e.g., 2.74 prerelease becomes 2.80 stable)
+- **Main branch after RC snap**: Jumps to one above the next stable version (e.g., if snapping 2.74 as RC, main becomes 2.81)
+
 ### Snap main -> prerelease
 The snap is done via the "Branch snap" github action.  To run the snap from main -> prerelease, run the action via "Run workflow" and choose main as the base branch.
 ![branch snap action](./docs/images/main_snap.png)
 
+When running the snap action, you can optionally check the "Is this a release candidate snap" checkbox. If checked:
+- The prerelease branch will receive the snapped code with the current version (e.g., 2.74)
+- The main branch version will be updated to be higher than the next stable release (e.g., 2.81, since the next stable would be 2.80)
+
 This will generate two PRs that must be merged.  One merging the main branch into prerelease, and the other bumps the version in main.
 ![generated prs](./docs/images/generated_prs.png)
 
 ### Snap prerelease -> release
-To snap from prerelease to release, run the same action but use **prerelease** as the workflow branch.  This will generate a single PR merging from prerelease to release.
+To snap from prerelease to release, run the same action but use **prerelease** as the workflow branch.  This will generate a PR merging from prerelease to release, and automatically update the version to the next stable release version (e.g., 2.74 -> 2.80) on the merge branch before the PR is merged.
 
 ### Marketplace release
 The marketplace release is managed by an internal AzDo pipeline.  On the pipeline page, hit run pipeline.  This will bring up the pipeline parameters to fill out:

jest.config.ts

@@ -14,6 +14,7 @@ const config: Config = {
         '<rootDir>/test/razor/razorIntegrationTests/jest.config.ts',
         '<rootDir>/test/razor/razorTests/jest.config.ts',
         '<rootDir>/test/untrustedWorkspace/integrationTests/jest.config.ts',
+        '<rootDir>/test/tasks/jest.config.ts',
     ],
     // Reporters are a global jest configuration property and cannot be set in the project jest config.
     // This configuration will create a 'junit.xml' file in the output directory, no matter which test project is running.

tasks/snapTasks.ts

@@ -10,6 +10,7 @@ import * as os from 'os';
 import { exec } from 'child_process';
 import { promisify } from 'util';
 import { findTagsByVersion } from './gitTasks';
+import minimist from 'minimist';
 
 const execAsync = promisify(exec);
 
@@ -20,27 +21,50 @@ function logWarning(message: string, error?: unknown): void {
     }
 }
 
-gulp.task('incrementVersion', async (): Promise<void> => {
-    // Get the current version from version.json
+/**
+ * Calculate the next release (stable) version from the current version.
+ * Rounds up the minor version to the next tens version.
+ * @param currentVersion The current version in "major.minor" format (e.g., "2.74")
+ * @returns The next stable release version (e.g., "2.80")
+ */
+export function getNextReleaseVersion(currentVersion: string): string {
+    const split = currentVersion.split('.');
+    const major = parseInt(split[0]);
+    const minor = parseInt(split[1]);
+
+    // Round up to the next tens version
+    const nextTensMinor = Math.ceil((minor + 1) / 10) * 10;
+
+    return `${major}.${nextTensMinor}`;
+}
+
+/**
+ * Read and parse version.json
+ * @returns The parsed version.json object
+ */
+function readVersionJson(): { version: string; [key: string]: unknown } {
     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}`);
+    return JSON.parse(file);
+}
 
-    // Write the new version back to version.json
-    versionJson.version = newVersion;
+/**
+ * Write version.json with the given version
+ * @param versionJson The version.json object to write
+ */
+function writeVersionJson(versionJson: { version: string; [key: string]: unknown }): void {
+    const versionFilePath = path.join(path.resolve(__dirname, '..'), 'version.json');
     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.
+/**
+ * Add a new version section to the changelog
+ * @param version The version to add (e.g., "2.75")
+ * @param additionalLines Optional additional lines to add after the version header
+ */
+function addChangelogSection(version: string, additionalLines?: string[]): void {
     console.log('Adding new version header to changelog');
 
     const changelogPath = path.join(path.resolve(__dirname, '..'), 'CHANGELOG.md');
@@ -71,10 +95,41 @@ gulp.task('incrementVersion', async (): Promise<void> => {
     // 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`];
+    const linesToInsert = ['', `# ${version}.x`];
+
+    // Add any additional lines if provided
+    if (additionalLines && additionalLines.length > 0) {
+        linesToInsert.push(...additionalLines);
+    }
 
     changelogLines.splice(lineToInsertAt, 0, ...linesToInsert);
     fs.writeFileSync(changelogPath, changelogLines.join(os.EOL));
+}
+
+gulp.task('incrementVersion', async (): Promise<void> => {
+    const argv = minimist(process.argv.slice(2));
+    const isReleaseCandidate = argv['releaseCandidate'] === true || argv['releaseCandidate'] === 'true';
+
+    // Get the current version from version.json
+    const versionJson = readVersionJson();
+
+    // Calculate new version
+    let version = versionJson.version as string;
+    if (isReleaseCandidate) {
+        version = getNextReleaseVersion(version);
+        console.log(`Release candidate, using base version of ${version}`);
+    }
+
+    const split = version.split('.');
+    const newVersion = `${split[0]}.${parseInt(split[1]) + 1}`;
+    console.log(`Updating ${versionJson.version} to ${newVersion}`);
+
+    // Write the new version back to version.json
+    versionJson.version = newVersion;
+    writeVersionJson(versionJson);
+
+    // Add a new changelog section for the new version.
+    addChangelogSection(newVersion);
 });
 
 gulp.task('updateChangelog', async (): Promise<void> => {
@@ -186,3 +241,25 @@ async function generatePRList(startSHA: string, endSHA: string): Promise<string[
         throw error;
     }
 }
+
+/**
+ * Update version.json to the next stable release version.
+ * This task is used when snapping from prerelease to release.
+ * It updates the version to round up to the next tens version (e.g., 2.74 -> 2.80).
+ */
+gulp.task('updateVersionForStableRelease', async (): Promise<void> => {
+    // Get the current version from version.json
+    const versionJson = readVersionJson();
+
+    const currentVersion = versionJson.version as string;
+    const releaseVersion = getNextReleaseVersion(currentVersion);
+
+    console.log(`Updating version from ${currentVersion} to stable release version ${releaseVersion}`);
+
+    // Write the new version back to version.json
+    versionJson.version = releaseVersion;
+    writeVersionJson(versionJson);
+
+    // Add a new changelog section for the release version that references the prerelease
+    addChangelogSection(releaseVersion, [`* See ${currentVersion}.x for full list of changes.`]);
+});

tasks/testTasks.ts

@@ -12,6 +12,7 @@ import { jestOmniSharpUnitTestProjectName } from '../test/omnisharp/omnisharpUni
 import { jestUnitTestProjectName } from '../test/lsptoolshost/unitTests/jest.config';
 import { razorTestProjectName } from '../test/razor/razorTests/jest.config';
 import { jestArtifactTestsProjectName } from '../test/lsptoolshost/artifactTests/jest.config';
+import { jestTasksTestProjectName } from '../test/tasks/jest.config';
 import {
     getJUnitFileName,
     integrationTestProjects,
@@ -46,7 +47,11 @@ function createUnitTestSubTasks() {
         await runJestTest(razorTestProjectName);
     });
 
-    gulp.task('test:unit', gulp.series('test:unit:csharp', 'test:unit:razor'));
+    gulp.task('test:unit:tasks', async () => {
+        await runJestTest(jestTasksTestProjectName);
+    });
+
+    gulp.task('test:unit', gulp.series('test:unit:csharp', 'test:unit:razor', 'test:unit:tasks'));
 }
 
 function createIntegrationTestSubTasks() {

test/tasks/jest.config.ts

@@ -0,0 +1,20 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import type { Config } from 'jest';
+import { baseProjectConfig } from '../../baseJestConfig';
+
+export const jestTasksTestProjectName = 'Tasks Unit Tests';
+
+/**
+ * Defines a jest project configuration for tasks unit tests.
+ */
+const tasksTestConfig: Config = {
+    ...baseProjectConfig,
+    displayName: jestTasksTestProjectName,
+    modulePathIgnorePatterns: ['out'],
+    roots: ['<rootDir>', '<rootDir>../../__mocks__'],
+};
+
+export default tasksTestConfig;

test/tasks/versionHelper.test.ts

@@ -0,0 +1,59 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { getNextReleaseVersion } from '../../tasks/snapTasks';
+import { describe, test, expect } from '@jest/globals';
+
+describe('getNextReleaseVersion', () => {
+    test('rounds up to next tens from single digit minor version', () => {
+        expect(getNextReleaseVersion('2.1')).toBe('2.10');
+        expect(getNextReleaseVersion('2.5')).toBe('2.10');
+        expect(getNextReleaseVersion('2.9')).toBe('2.10');
+    });
+
+    test('rounds up to next tens from teens minor version', () => {
+        expect(getNextReleaseVersion('2.10')).toBe('2.20');
+        expect(getNextReleaseVersion('2.15')).toBe('2.20');
+        expect(getNextReleaseVersion('2.19')).toBe('2.20');
+    });
+
+    test('rounds up to next tens from twenties minor version', () => {
+        expect(getNextReleaseVersion('2.20')).toBe('2.30');
+        expect(getNextReleaseVersion('2.25')).toBe('2.30');
+        expect(getNextReleaseVersion('2.29')).toBe('2.30');
+    });
+
+    test('rounds up from 74 to 80', () => {
+        expect(getNextReleaseVersion('2.74')).toBe('2.80');
+    });
+
+    test('rounds up from 75 to 80', () => {
+        expect(getNextReleaseVersion('2.75')).toBe('2.80');
+    });
+
+    test('rounds up from 79 to 80', () => {
+        expect(getNextReleaseVersion('2.79')).toBe('2.80');
+    });
+
+    test('rounds up from 80 to 90', () => {
+        expect(getNextReleaseVersion('2.80')).toBe('2.90');
+    });
+
+    test('rounds up from 90 to 100', () => {
+        expect(getNextReleaseVersion('2.90')).toBe('2.100');
+    });
+
+    test('works with different major versions', () => {
+        expect(getNextReleaseVersion('1.74')).toBe('1.80');
+        expect(getNextReleaseVersion('3.55')).toBe('3.60');
+        expect(getNextReleaseVersion('10.99')).toBe('10.100');
+    });
+
+    test('handles version at exactly tens boundary', () => {
+        expect(getNextReleaseVersion('2.10')).toBe('2.20');
+        expect(getNextReleaseVersion('2.20')).toBe('2.30');
+        expect(getNextReleaseVersion('2.30')).toBe('2.40');
+    });
+});