Add task for automatically creating the github release

dibarbet · dibarbet · commit 9b3446f91cf7 · 2025-08-14T16:37:12.000-07:00
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -0,0 +1,18 @@
+name: Create GitHub Release
+on:
+  push:
+    tags:
+      - 'v2.*'
+
+permissions:
+  contents: write
+
+jobs:
+  # This job runs against the yaml defined in the tag we were triggered on.
+  # So we can modify the release creation without having to wait for the change to flow into the commit
+  # that we're tagging, we call a reusable workflow from main
+  create-release:
+    uses: dotnet/vscode-csharp/.github/workflows/release-reusable.yml@main
+    with:
+      tag: ${{ github.ref_name }}
+    secrets: inherit
diff --git a/.github/workflows/release-reusable.yml b/.github/workflows/release-reusable.yml
@@ -0,0 +1,73 @@
+name: Reusable - Create Release from Changelog
+
+on:
+  workflow_call:
+    inputs:
+      tag:
+        description: Tag name to create a release for (e.g. v2.88.0 or v2.88.0-prerelease)
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        with:
+          ref: refs/tags/${{ inputs.tag }}
+
+      - name: Create release from CHANGELOG
+        uses: actions/github-script@v7
+        env:
+          TAG: ${{ inputs.tag }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { readFile } = require('fs/promises');
+
+            const tag = process.env.TAG;
+            core.info(`Creating release for tag: ${tag}`);
+
+            if (!tag || !tag.startsWith('v2.')) {
+              core.setFailed('Invalid tag name. Tag name must start with "v2."');
+              return;
+            }
+
+            // Read CHANGELOG.md and extract the latest section (first single '#' header)
+            const changelog = await readFile('CHANGELOG.md', 'utf8');
+            const headerMatch = changelog.match(/^# .+$/m);
+            if (!headerMatch) {
+              core.setFailed('Could not find a top-level # header in CHANGELOG.md');
+              return;
+            }
+            const startIdx = changelog.indexOf(headerMatch[0]);
+            let endIdx = changelog.indexOf('\n# ', startIdx + headerMatch[0].length);
+            if (endIdx === -1) {
+              endIdx = changelog.length;
+            }
+            const releaseNotes = changelog.substring(startIdx, endIdx).trim();
+
+            const isPrerelease = tag.includes('-prerelease');
+            core.info(`Prerelease: ${isPrerelease}`);
+
+            try {
+              const response = await github.rest.repos.createRelease({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                tag_name: tag,
+                name: tag,
+                body: releaseNotes,
+                prerelease: isPrerelease,
+              });
+              core.info(`Release created: ${response.data.html_url}`);
+            } catch (err) {
+              if (err && err.status === 422 && err.message && String(err.message).includes('already_exists')) {
+                core.warning(`Release for tag '${tag}' already exists.`);
+              } else {
+                core.setFailed(`Error creating release: ${err?.message ?? err}`);
+              }
+            }
diff --git a/azure-pipelines/release.yml b/azure-pipelines/release.yml
@@ -112,8 +112,10 @@ extends:
                     If ( $uploadPrerelease ) {
                       $basePublishArgs += "--pre-release"
                       Write-Host "Publish to pre-release channel."
+                      Write-Host "##vso[task.setvariable variable=isPrerelease]true"
                     } Else {
                       Write-Host "Publish to release channel."
+                      Write-Host "##vso[task.setvariable variable=isPrerelease]false"
                     }
                     $basePublishArgs += '--azure-credential'
                     $basePublishArgs += '--packagePath'
@@ -163,7 +165,7 @@ extends:
           displayName: 'Install dependencies.'
         - pwsh: |
             # build number is generated by nerdbank git versioning and set to AzureDev
-            gulp createTags --releaseVersion $(resources.pipeline.officialBuildCI.runName) --releaseCommit $(resources.pipeline.officialBuildCI.sourceCommit) --dryRun ${{ parameters.test }}
+            gulp createTags --releaseVersion $(resources.pipeline.officialBuildCI.runName) --releaseCommit $(resources.pipeline.officialBuildCI.sourceCommit) --dryRun ${{ parameters.test }} --prerelease $(isPrerelease)
           env:
             GitHubPAT: $(BotAccount-dotnet-bot-content-rw-grained-pat)
           displayName: 'Create release tags'
diff --git a/tasks/createTagsTasks.ts b/tasks/createTagsTasks.ts
@@ -11,68 +11,78 @@ import { allNugetPackages, NugetPackageInfo, platformSpecificPackages } from './
 import { PlatformInformation } from '../src/shared/platform';
 import path from 'path';
 
-interface Options {
+interface CreateTagsOptions {
     releaseVersion: string;
     releaseCommit: string;
     // Even it is specified as boolean, it would still be parsed as string in compiled js.
     dryRun: string;
     githubPAT: string | null;
+    prerelease: string | null;
 }
 
 gulp.task('createTags:roslyn', async (): Promise<void> => {
-    const options = minimist<Options>(process.argv.slice(2));
+    const options = minimist<CreateTagsOptions>(process.argv.slice(2));
 
     return createTagsAsync(
         options,
         'dotnet',
         'roslyn',
         async () => getCommitFromNugetAsync(allNugetPackages.roslyn),
-        (releaseVersion: string): [string, string] => [
-            `VSCode-CSharp-${releaseVersion}`,
-            `${releaseVersion} VSCode C# extension release`,
-        ]
+        (releaseVersion: string, isPrerelease: boolean): [string, string] => {
+            const prereleaseText = isPrerelease ? '-prerelease' : '';
+            return [
+                `VSCode-CSharp-${releaseVersion}${prereleaseText}`,
+                `${releaseVersion} VSCode C# extension ${prereleaseText}`,
+            ];
+        }
     );
 });
 
 gulp.task('createTags:razor', async (): Promise<void> => {
-    const options = minimist<Options>(process.argv.slice(2));
+    const options = minimist<CreateTagsOptions>(process.argv.slice(2));
 
     return createTagsAsync(
         options,
         'dotnet',
         'razor',
         async () => getCommitFromNugetAsync(allNugetPackages.razor),
-        (releaseVersion: string): [string, string] => [
-            `VSCode-CSharp-${releaseVersion}`,
-            `${releaseVersion} VSCode C# extension release`,
-        ]
+        (releaseVersion: string, isPrerelease: boolean): [string, string] => {
+            const prereleaseText = isPrerelease ? '-prerelease' : '';
+            return [
+                `VSCode-CSharp-${releaseVersion}${prereleaseText}`,
+                `${releaseVersion} VSCode C# extension ${prereleaseText}`,
+            ];
+        }
     );
 });
 
 gulp.task('createTags:vscode-csharp', async (): Promise<void> => {
-    const options = minimist<Options>(process.argv.slice(2));
+    const options = minimist<CreateTagsOptions>(process.argv.slice(2));
 
     return createTagsAsync(
         options,
         'dotnet',
         'vscode-csharp',
         async () => options.releaseCommit,
-        (releaseVersion: string): [string, string] => [`v${releaseVersion}`, releaseVersion]
+        (releaseVersion: string, isPrerelease: boolean): [string, string] => {
+            const prereleaseText = isPrerelease ? '-prerelease' : '';
+            return [`v${releaseVersion}${prereleaseText}`, releaseVersion];
+        }
     );
 });
 
 gulp.task('createTags', gulp.series('createTags:roslyn', 'createTags:razor', 'createTags:vscode-csharp'));
 
 async function createTagsAsync(
-    options: Options,
+    options: CreateTagsOptions,
     owner: string,
     repo: string,
     getCommit: () => Promise<string | null>,
-    getTagAndMessage: (releaseVersion: string) => [string, string]
+    getTagAndMessage: (releaseVersion: string, isPrerelease: boolean) => [string, string]
 ): Promise<void> {
     console.log(`releaseVersion: ${options.releaseVersion}`);
     console.log(`releaseCommit: ${options.releaseCommit}`);
-    const dryRun = options.dryRun ? options.dryRun.toLocaleLowerCase() === 'true' : false;
+    const dryRun = getFlag('dryRun', options);
     console.log(`dry run: ${dryRun}`);
 
     const commit = await getCommit();
@@ -81,7 +91,8 @@ async function createTagsAsync(
         return;
     }
 
-    const [tag, message] = getTagAndMessage(options.releaseVersion);
+    const prerelease = getFlag('prerelease', options);
+    const [tag, message] = getTagAndMessage(options.releaseVersion, prerelease);
     console.log(`tag: ${tag}`);
     console.log(`message: ${message}`);
 
@@ -90,7 +101,8 @@ async function createTagsAsync(
         console.log('Tagging is skipped in dry run mode.');
         return;
     } else {
-        const tagCreated = await tagRepoAsync(owner, repo, commit, tag, message, options.githubPAT);
+        const githubPAT = getGitHubPAT(options);
+        const tagCreated = await tagRepoAsync(owner, repo, commit, tag, message, githubPAT);
 
         if (!tagCreated) {
             logError(`Failed to tag '${owner}/${repo}'`);
@@ -107,15 +119,10 @@ async function tagRepoAsync(
     commit: string,
     releaseTag: string,
     tagMessage: string,
-    githubPAT: string | null
+    githubPAT: string
 ): Promise<boolean> {
-    const pat = githubPAT ?? process.env['GitHubPAT'];
-    if (!pat) {
-        throw 'No GitHub Pat found. Specify with --githubPAT or set GitHubPAT environment variable.';
-    }
-
     console.log(`Start to tag ${owner}/${repo}. Commit: ${commit}, tag: ${releaseTag}, message: ${tagMessage}`);
-    const octokit = new Octokit({ auth: pat });
+    const octokit = new Octokit({ auth: githubPAT });
     await octokit.auth();
     const createTagResponse = await octokit.request(`POST /repos/${owner}/${repo}/git/tags`, {
         owner: owner,
@@ -130,25 +137,62 @@ async function tagRepoAsync(
         logError(`Failed to create tag for ${commit} in ${owner}/${repo}.`);
         return false;
     }
-    const refCreationResponse = await octokit.request(`Post /repos/${owner}/${repo}/git/refs`, {
-        owner: owner,
-        repo: repo,
-        ref: `refs/tags/${releaseTag}`,
-        sha: commit,
-    });
-
-    if (refCreationResponse.status !== 201) {
-        logError(`Failed to create reference for ${commit} in ${owner}/${repo}.`);
-        return false;
+    try {
+        const refCreationResponse = await octokit.request(`Post /repos/${owner}/${repo}/git/refs`, {
+            owner: owner,
+            repo: repo,
+            ref: `refs/tags/${releaseTag}`,
+            sha: commit,
+        });
+
+        if (refCreationResponse.status !== 201) {
+            logError(`Failed to create reference for ${commit} in ${owner}/${repo}.`);
+            return false;
+        }
+    } catch (err: any) {
+        if (err.status === 422 && err.message && err.message.includes('Reference already exists')) {
+            logWarning(`Reference for tag '${releaseTag}' already exists in ${owner}/${repo}.`);
+            return true;
+        } else {
+            logError(`Failed to create reference for ${commit} in ${owner}/${repo}: ${err}`);
+            return false;
+        }
     }
 
     console.log(`Tag is created.`);
     return true;
 }
 
+// --- Helper functions ---
+
+function getGitHubPAT(options: { githubPAT?: string | null }): string {
+    const pat = options.githubPAT ?? process.env['GitHubPAT'];
+    if (!pat) {
+        throw 'No GitHub Pat found. Specify with --githubPAT or set GitHubPAT environment variable.';
+    }
+    return pat;
+}
+
+function getFlag<T extends CreateTagsOptions>(option: keyof T, options: T): boolean {
+    const value = options[option];
+    if (!value) {
+        logError(`Missing required argument: --${option.toString()}`);
+    }
+    if (typeof value === 'string') {
+        return value.toLocaleLowerCase() === 'true';
+    } else {
+        throw new Error(`Expected boolean value for --${option.toString()}, but got ${typeof value}`);
+    }
+}
+
+function logWarning(message: string): void {
+    console.log(`##vso[task.logissue type=warning]${message}`);
+}
+
 function logError(message: string): void {
     console.log(`##vso[task.logissue type=error]${message}`);
 }
+
 async function getCommitFromNugetAsync(packageInfo: NugetPackageInfo): Promise<string | null> {
     const packageJsonString = fs.readFileSync('./package.json').toString();
     const packageJson = JSON.parse(packageJsonString);
