Setup to use release branches for ADO

This will let us use the pipeline trigger because we can set the default
branch for manual/scheduled/pipeline-triggered builds to `release` (but
cannot set it to a variable branch, like `release/vX.Y.Z`).

Author: andyleejordan

.vsts-ci/azure-pipelines-release.yml

@@ -6,10 +6,7 @@ variables:
   - name: DOTNET_CLI_TELEMETRY_OPTOUT
     value: 'true'
 
-trigger:
-  branches:
-    include:
-      - release/*
+trigger: none
 
 resources:
   repositories:
@@ -20,12 +17,8 @@ resources:
   pipelines:
   - pipeline: PowerShellEditorServices
     source: PowerShellEditorServices
-    trigger:
-      branches:
-        include:
-        - release/*
-      tags:
-      - v*
+    trigger: true
+
 
 jobs:
 - job: 'ReleaseBuild'

docs/development.md

@@ -67,24 +67,23 @@ Microsoft. The comments are manual steps.
 Import-Module ./tools/ReleaseTools.psm1
 Update-Changelog -RepositoryName PowerShellEditorServices -Version <version>
 Update-Changelog -RepositoryName vscode-powershell -Version <version>
-# Amend changelog as necessary
-# Download and test assets (assert correct PSES is included)
-New-DraftRelease -RepositoryName PowerShellEditorServices -Assets "PowerShellEditorServices.zip"
-New-DraftRelease -RepositoryName vscode-powershell -Assets "powershell-YYYY.M.X.vsix", "Install-VSCode.ps1"
+# Amend changelog as necessary, open PR
+# Push release branches to ADO
+# Permit both pipelines to draft GitHub releases
+# Download and test assets
 # Check telemetry for stability before releasing
 # Publish draft releases and merge (don't squash!) branches
-vsce publish --packagePath ./PowerShell-<version>.vsix
-# Update Install-VSCode.ps1 on gallery
-Publish-Script -Path ./Install-VSCode.ps1 -NuGetApiKey (Get-Secret "PowerShell Gallery API Key" -AsPlainText)
+# Permit vscode-extension pipeline to publish to marketplace
 ```
 
 ### Versioning
 
-For both our repositories we use Git tags in the form `vX.Y.Z` to mark the
-releases in the codebase. We use the GitHub Release feature to create these
-tags. Branches are used in the process of creating a release, e.g.
-`release/vX.Y.Z`, but are deleted after the release is completed (and merged
-into `master`).
+For both our repositories we use Git tags in the form `vX.Y.Z` to mark the releases in the
+codebase. We use the GitHub Release feature to create these tags. The ephemeral branch
+`release` is used in the process of creating a release for each repository, primarily for
+the Pull Requests and for Azure DevOps triggers. Once the release PRs are merged, the
+branch is deleted until used again to prepare the next release. This branch _does not_
+mark any specific release, that is the point of the tags.
 
 For PowerShellEditor Services, we simply follow semantic versioning, e.g.
 `vX.Y.Z`. We do not release previews frequently because this dependency is not
@@ -130,4 +129,3 @@ use the same code which includes dependencies).
 
 * `Update-Changelog` should verify the version is in the correct format
 * `Update-Changelog` could be faster by not downloading _every_ PR
-* A `Publish-Binaries` function could be written to push the binaries out

tools/ReleaseTools.psm1

@@ -136,26 +136,21 @@ function Get-FirstChangelog {
 
 <#
 .SYNOPSIS
-  Creates and checks out `release/v<version>` if not already on it.
+  Creates and checks out `release` if not already on it.
 #>
 function Update-Branch {
     [CmdletBinding(SupportsShouldProcess)]
-    param(
-        [Parameter(Mandatory)]
-        [string]$Version
-    )
     $Branch = git branch --show-current
-    $NewBranch = "release/v$Version"
-    if ($Branch -ne $NewBranch) {
-        if ($PSCmdlet.ShouldProcess($NewBranch, "git checkout -b")) {
-            git checkout -b $NewBranch
+    if ($Branch -ne "release") {
+        if ($PSCmdlet.ShouldProcess("release", "git checkout -b")) {
+            git checkout -b "release"
         }
     }
 }
 
 <#
 .SYNOPSIS
-  Gets current version from changelog as [semver].
+  Gets current version from changelog as `[semver]`.
 #>
 function Get-Version {
     param(
@@ -176,10 +171,9 @@ function Get-Version {
 .SYNOPSIS
   Updates the CHANGELOG file with PRs merged since the last release.
 .DESCRIPTION
-  Uses the local Git repositories but does not pull, so ensure HEAD is where
-  you want it. Creates a new branch at 'release/$Version' if not already
-  checked out. Handles any merge option for PRs, but is a little slow as it
-  queries all PRs.
+  Uses the local Git repositories but does not pull, so ensure HEAD is where you
+  want it. Creates the branch `release` if not already checked out. Handles any
+  merge option for PRs, but is a little slow as it queries all PRs.
 #>
 function Update-Changelog {
     [CmdletBinding(SupportsShouldProcess)]
@@ -238,7 +232,7 @@ function Update-Changelog {
         $CurrentChangelog[2..$CurrentChangelog.Length]
     ) | Set-Content -Encoding utf8NoBOM -Path $ChangelogFile
 
-    Update-Branch -Version $Version.Substring(1) # Has "v" prefix
+    Update-Branch
 
     if ($PSCmdlet.ShouldProcess("$RepositoryName/$ChangelogFile", "git commit")) {
         git add $ChangelogFile
@@ -328,7 +322,7 @@ function Update-Version {
         }
     }
 
-    Update-Branch -Version $Version
+    Update-Branch
 
     if ($PSCmdlet.ShouldProcess("$RepositoryName/v$Version", "git commit")) {
         git commit -m "Bump version to ``v$Version``"
@@ -409,7 +403,7 @@ function New-DraftRelease {
     $ReleaseParams = @{
         # NOTE: We rely on GitHub to create the tag at that branch.
         Tag            = "v$Version"
-        Committish     = "release/v$Version"
+        Committish     = "release"
         Name           = "v$Version"
         Body           = $ChangeLog
         Draft          = $true