create extension with locked tool version (dotnet#1338)

Author: brettfo

INTERNAL.md

@@ -14,13 +14,21 @@ NuGet packages produced from every build of `main` are auto-published to the NuG
 
 ## Publish VS Code Extension
 
-The repo produces two versions of the VS Code extension on every build; one for Stable, the other for Insiders, and they both target the same backing tool.
+The signed build produces three versions of the VS Code extension, 2 against Stable VS Code and 1 against Insiders.  Both versions against Stable append a `"0"` character to the extension version number and Insiders appends a `"1"` character.
 
-The Stable version of the extension can be published from a specified build via [this](https://dev.azure.com/dnceng/internal/_release?_a=releases&view=mine&definitionId=86) release definition.  The extension version number for Stable will always be the version of the internal tool plus another `"0"` character, e.g., if the tool version is `1.0.123456`, then the Stable extension will be version `1.0.1234560`.  Due to how the VS Code marketplace handles extensions, this _also_ will publish the corresponding Insiders version.
+### Stable with locked tool version
 
-The Insiders version of the extension can be published from a specified build via [this](https://dev.azure.com/dnceng/internal/_release?_a=releases&view=mine&definitionId=103) release definition.  The extension number for Insiders will always be the version of the internal tool plus another `"1"` character, e.g., if the tool version is `1.0.123456`, then the Insiders extension will be version `1.0.1234561`.
+The Stable extension with the locked tool version can be published via [this](https://dev.azure.com/dnceng/internal/_release?_a=releases&view=mine&definitionId=86) release definition.  **This will also immediately publish the corresponding Insiders version of the extension.**
 
-Once either of those release definitions are invoked, the new extension will appear in the VS Code marketplace approximately 10 minutes later, after the marketplace has run their own internal validation.
+### Stable with latest tool
+
+The Stable extension with the latest tool can be published via [this](https://dev.azure.com/dnceng/internal/_release?_a=releases&view=mine&definitionId=115) release definition.  **This will also immediately publish the corresponding Insiders version of the extension.**
+
+### Insiders with latest tool
+
+The Insiders extension with the latest tool can be published via [this](https://dev.azure.com/dnceng/internal/_release?_a=releases&view=mine&definitionId=103) release definition.
+
+Once any of those release definitions are invoked, the new extension will appear in the VS Code marketplace approximately 10 minutes later, after the marketplace has run their own internal validation.
 
 The publish/verification script is located in this repo at [`eng/publish/PublishVSCodeExtension.ps1`](eng/publish/PublishVSCodeExtension.ps1).
 

eng/package/PackUtilities.ps1

@@ -19,6 +19,11 @@ function SetNpmVersionNumber([PSCustomObject]$packageJsonContents, [string]$pack
 
 function AddGitShaToDescription([PSCustomObject]$packageJsonContents, [string]$gitSha) {
     Write-Host "Appending git SHA $gitSha to description."
+    $shaIndex = $packageJsonContents.description.IndexOf("  Git SHA ")
+    if ($shaIndex -ge 0) {
+        $packageJsonContents.description = $packageJsonContents.description.Substring(0, $shaIndex)
+    }
+
     $packageJsonContents.description += "  Git SHA $gitSha"
 }
 

eng/package/PackVSCodeExtension.ps1

@@ -8,7 +8,7 @@ param (
 Set-StrictMode -version 2.0
 $ErrorActionPreference = "Stop"
 
-function Build-VsCodeExtension([string] $packageDirectory, [string] $packageVersionNumber, [string] $kernelVersionNumber) {
+function Build-VsCodeExtension([string] $packageDirectory, [string] $outputSubDirectory = "", [string] $packageVersionNumber, [string] $kernelVersionNumber = "") {
     Push-Location $packageDirectory
 
     $packageJsonPath = Join-Path (Get-Location) "package.json"
@@ -17,17 +17,22 @@ function Build-VsCodeExtension([string] $packageDirectory, [string] $packageVers
     AddGitShaToDescription -packageJsonContents $packageJsonContents -gitSha $gitSha
 
     # set tool version
-    Write-Host "Setting tool version to $kernelVersionNumber"
-    $packageJsonContents.contributes.configuration.properties."dotnet-interactive.minimumInteractiveToolVersion"."default" = $kernelVersionNumber
+    if ($kernelVersionNumber -Ne "") {
+        Write-Host "Setting tool version to $kernelVersionNumber"
+        $packageJsonContents.contributes.configuration.properties."dotnet-interactive.minimumInteractiveToolVersion"."default" = $kernelVersionNumber
+    }
 
     SaveJson -packageJsonPath $packagejsonPath -packageJsonContents $packageJsonContents
 
     # create destination
-    EnsureCleanDirectory -location "$outDir\$packageDirectory"
+    if ($outputSubDirectory -Eq "") {
+        $outputSubDirectory = $packageDirectory
+    }
+    EnsureCleanDirectory -location "$outDir\$outputSubDirectory"
 
     # pack
     Write-Host "Packing extension"
-    npx vsce package --out "$outDir\$packageDirectory\dotnet-interactive-vscode-$packageVersionNumber.vsix"
+    npx vsce package --out "$outDir\$outputSubDirectory\dotnet-interactive-vscode-$packageVersionNumber.vsix"
 
     Pop-Location
 }
@@ -41,6 +46,7 @@ try {
 
     $stablePackageVersion = "${stableToolVersionNumber}0"
     $insidersPackageVersion = "${stableToolVersionNumber}1"
+    Build-VsCodeExtension -packageDirectory "stable" -outputSubDirectory "stable-locked" -packageVersionNumber $stablePackageVersion
     Build-VsCodeExtension -packageDirectory "stable" -packageVersionNumber $stablePackageVersion -kernelVersionNumber $stableToolVersionNumber
     Build-VsCodeExtension -packageDirectory "insiders" -packageVersionNumber $insidersPackageVersion -kernelVersionNumber $stableToolVersionNumber
 }