Add a Nightly build pipeline for the Canary branding (#15869)

To make this happen, I moved most of `release.yml` into a shared _pipeline_ template (which is larger than a steps or jobs template). Most of the diffs are due to that move. If you compare main:build/pipelines/release.yml against dev/duhowett/nightly-build:build/pipelines/templates-v2/pipeline-full-release-build.yml, you will see that the changes are much more minimal than they look. I also added a parameter to configure how long symbols will be kept. It defaults to 36530 days (which is the default for the PublishSymbols task! Yes, 100 years!) but nightly builds will get 15 days.
2025-12-10 00:48:23 -06:00 · 2023-08-24 17:15:54 -05:00 · 2023-08-24 17:15:54 -05:00 · 5651f08770
commit 5651f08770
parent 0f61b5f97d
5 changed files with 240 additions and 139 deletions
--- a/build/pipelines/nightly.yml
+++ b/build/pipelines/nightly.yml
@ -0,0 +1,23 @@
+trigger: none
+pr: none
+schedules:
+  - cron: "30 3 * * 2-6" # Run at 03:30 UTC Tuesday through Saturday (After the work day in Pacific, Mon-Fri)
+    displayName: "Nightly Terminal Build"
+    branches:
+      include:
+        - main
+    always: false # only run if there's code changes!
+
+name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr)
+
+extends:
+  template: templates-v2\pipeline-full-release-build.yml
+  parameters:
+    branding: Canary
+    buildTerminal: true
+    pgoBuildMode: Optimize
+    codeSign: true
+    generateSbom: true
+    publishSymbolsToPublic: true
+    publishVpackToWindows: false
+    symbolExpiryTime: 15 # Nightly builds do not keep symbols for very long!
--- a/build/pipelines/release.yml
+++ b/build/pipelines/release.yml
@ -1,11 +1,7 @@
-# This build should never run as CI or against a pull request.
 trigger: none
 pr: none

-pool:
-  name: SHINE-INT-S # By default, send jobs to the small agent pool.
-  demands: ImageOverride -equals SHINE-VS17-Latest
-
+# Expose all of these parameters for user configuration.
 parameters:
  - name: branding
    displayName: "Branding (Build Type)"
@ -70,138 +66,20 @@ parameters:
    type: boolean
    default: false

-variables:
-  # If we are building a branch called "release-*", change the NuGet suffix
-  # to "preview". If we don't do that, XES will set the suffix to "release1"
-  # because it truncates the value after the first period.
-  # We also want to disable the suffix entirely if we're Release branded while
-  # on a release branch.
-  # main is special, however. XES ignores main. Since we never produce actual
-  # shipping builds from main, we want to force it to have a beta label as
-  # well.
-  #
-  # In effect:
-  # BRANCH / BRANDING | Release                    | Preview
-  # ------------------|----------------------------|-----------------------------
-  # release-*         | 1.12.20220427              | 1.13.20220427-preview
-  # main              | 1.14.20220427-experimental | 1.14.20220427-experimental
-  # all others        | 1.14.20220427-mybranch     | 1.14.20220427-mybranch
-  ${{ if startsWith(variables['Build.SourceBranchName'], 'release-') }}:
-    ${{ if eq(parameters.branding, 'Release') }}:
-      NoNuGetPackBetaVersion: true
-    ${{ else }}:
-      NuGetPackBetaVersion: preview
-  ${{ elseif eq(variables['Build.SourceBranchName'], 'main') }}:
-    NuGetPackBetaVersion: experimental
-
 name: $(BuildDefinitionName)_$(date:yyMM).$(date:dd)$(rev:rrr)

-resources:
-  repositories:
-  - repository: self
-    type: git
-    ref: main
-
-stages:
-  - stage: Build
-    displayName: Build
-    dependsOn: []
-    jobs:
-      - template: ./templates-v2/job-build-project.yml
-        parameters:
-          pool:
-            name: SHINE-INT-L # Run the compilation on the large agent pool, rather than the default small one.
-            demands: ImageOverride -equals SHINE-VS17-Latest
-          branding: ${{ parameters.branding }}
-          buildTerminal: ${{ parameters.buildTerminal }}
-          buildConPTY: ${{ parameters.buildConPTY }}
-          buildWPF: ${{ parameters.buildWPF }}
-          pgoBuildMode: ${{ parameters.pgoBuildMode }}
-          buildConfigurations: ${{ parameters.buildConfigurations }}
-          buildPlatforms: ${{ parameters.buildPlatforms }}
-          generateSbom: ${{ parameters.generateSbom }}
-          codeSign: ${{ parameters.codeSign }}
-          beforeBuildSteps: # Right before we build, lay down the universal package and localizations
-            - task: PkgESSetupBuild@12
-              displayName: Package ES - Setup Build
-              inputs:
-                disableOutputRedirect: true
-
-            - task: UniversalPackages@0
-              displayName: Download terminal-internal Universal Package
-              inputs:
-                feedListDownload: 2b3f8893-a6e8-411f-b197-a9e05576da48
-                packageListDownload: e82d490c-af86-4733-9dc4-07b772033204
-                versionListDownload: ${{ parameters.terminalInternalPackageVersion }}
-
-            - template: ./templates-v2/steps-fetch-and-prepare-localizations.yml
-              parameters:
-                includePseudoLoc: true
-
-      - ${{ if eq(parameters.buildWPF, true) }}:
-        # Add an Any CPU build flavor for the WPF control bits
-        - template: ./templates-v2/job-build-project.yml
-          parameters:
-            # This job is allowed to run on the default small pool.
-            jobName: BuildWPF
-            branding: ${{ parameters.branding }}
-            buildTerminal: false
-            buildWPFDotNetComponents: true
-            buildConfigurations: ${{ parameters.buildConfigurations }}
-            buildPlatforms:
-              - Any CPU
-            generateSbom: ${{ parameters.generateSbom }}
-            codeSign: ${{ parameters.codeSign }}
-            beforeBuildSteps:
-              - task: PkgESSetupBuild@12
-                displayName: Package ES - Setup Build
-                inputs:
-                  disableOutputRedirect: true
-              # WPF doesn't need the localizations or the universal package, but if it does... put them here.
-
-  - stage: Package
-    displayName: Package
-    dependsOn: [Build]
-    jobs:
-      - ${{ if eq(parameters.buildTerminal, true) }}:
-        - template: ./templates-v2/job-merge-msix-into-bundle.yml
-          parameters:
-            jobName: Bundle
-            branding: ${{ parameters.branding }}
-            buildConfigurations: ${{ parameters.buildConfigurations }}
-            buildPlatforms: ${{ parameters.buildPlatforms }}
-            generateSbom: ${{ parameters.generateSbom }}
-            codeSign: ${{ parameters.codeSign }}
-
-      - ${{ if eq(parameters.buildConPTY, true) }}:
-        - template: ./templates-v2/job-package-conpty.yml
-          parameters:
-            buildConfigurations: ${{ parameters.buildConfigurations }}
-            buildPlatforms: ${{ parameters.buildPlatforms }}
-            generateSbom: ${{ parameters.generateSbom }}
-            codeSign: ${{ parameters.codeSign }}
-
-      - ${{ if eq(parameters.buildWPF, true) }}:
-        - template: ./templates-v2/job-build-package-wpf.yml
-          parameters:
-            buildConfigurations: ${{ parameters.buildConfigurations }}
-            buildPlatforms: ${{ parameters.buildPlatforms }}
-            generateSbom: ${{ parameters.generateSbom }}
-            codeSign: ${{ parameters.codeSign }}
-
-  - stage: Publish
-    displayName: Publish
-    dependsOn: [Build, Package]
-    jobs:
-      # We only support the vpack for Release builds that include Terminal
-      - ${{ if and(containsValue(parameters.buildConfigurations, 'Release'), parameters.buildTerminal, parameters.publishVpackToWindows) }}:
-        - template: ./templates-v2/job-submit-windows-vpack.yml
-          parameters:
-            buildConfiguration: Release
-            generateSbom: ${{ parameters.generateSbom }}
-
-      - template: ./templates-v2/job-publish-symbols.yml
-        parameters:
-          includePublicSymbolServer: ${{ parameters.publishSymbolsToPublic }}
-
-...
+extends:
+  template: templates-v2/pipeline-full-release-build.yml
+  parameters:
+    branding: ${{ parameters.branding }}
+    buildTerminal: ${{ parameters.buildTerminal }}
+    buildConPTY: ${{ parameters.buildConPTY }}
+    buildWPF: ${{ parameters.buildWPF }}
+    pgoBuildMode: ${{ parameters.pgoBuildMode }}
+    buildConfigurations: ${{ parameters.buildConfigurations }}
+    buildPlatforms: ${{ parameters.buildPlatforms }}
+    codeSign: ${{ parameters.codeSign }}
+    generateSbom: ${{ parameters.generateSbom }}
+    terminalInternalPackageVersion: ${{ parameters.terminalInternalPackageVersion }}
+    publishSymbolsToPublic: ${{ parameters.publishSymbolsToPublic }}
+    publishVpackToWindows: ${{ parameters.publishVpackToWindows }}
--- a/build/pipelines/templates-v2/job-build-project.yml
+++ b/build/pipelines/templates-v2/job-build-project.yml
@ -2,7 +2,6 @@ parameters:
  - name: branding
    type: string
    default: Dev
-    values: [Release, Preview, Dev]
  - name: additionalBuildOptions
    type: string
    default: ''
--- a/build/pipelines/templates-v2/job-publish-symbols.yml
+++ b/build/pipelines/templates-v2/job-publish-symbols.yml
@ -14,6 +14,9 @@ parameters:
  - name: jobName
    type: string
    default: PublishSymbols
+  - name: symbolExpiryTime
+    type: string
+    default: 36530 # This is the default from PublishSymbols@2

 jobs:
 - job: ${{ parameters.jobName }}
@ -55,6 +58,7 @@ jobs:
      SymbolServerType: 'TeamServices'
      SymbolsProduct: 'Windows Terminal Converged Symbols'
      SymbolsVersion: '$(XES_APPXMANIFESTVERSION)'
+      SymbolExpirationInDays: ${{ parameters.symbolExpiryTime }}
    env:
      LIB: $(Build.SourcesDirectory)

@ -71,6 +75,7 @@ jobs:
        SymbolServerType: 'TeamServices'
        SymbolsProduct: 'Windows Terminal Converged Symbols'
        SymbolsVersion: '$(XES_APPXMANIFESTVERSION)'
+        SymbolExpirationInDays: ${{ parameters.symbolExpiryTime }}
        # The ADO task does not support indexing of GitHub sources.
      # There is a bug which causes this task to fail if LIB includes an inaccessible path (even though it does not depend on it).
      # To work around this issue, we just force LIB to be any dir that we know exists.
--- a/build/pipelines/templates-v2/pipeline-full-release-build.yml
+++ b/build/pipelines/templates-v2/pipeline-full-release-build.yml
@ -0,0 +1,196 @@
+# This build should never run as CI or against a pull request.
+trigger: none
+
+parameters:
+  - name: branding
+    type: string
+    default: Release
+  - name: buildTerminal
+    type: boolean
+    default: true
+  - name: buildConPTY
+    type: boolean
+    default: false
+  - name: buildWPF
+    type: boolean
+    default: false
+  - name: pgoBuildMode
+    type: string
+    default: Optimize
+    values:
+      - Optimize
+      - Instrument
+      - None
+  - name: buildConfigurations
+    type: object
+    default:
+      - Release
+  - name: buildPlatforms
+    type: object
+    default:
+      - x64
+      - x86
+      - arm64
+  - name: codeSign
+    type: boolean
+    default: true
+  - name: generateSbom
+    type: boolean
+    default: true
+  - name: terminalInternalPackageVersion
+    type: string
+    default: '0.0.8'
+
+  - name: publishSymbolsToPublic
+    type: boolean
+    default: true
+  - name: symbolExpiryTime
+    type: string
+    default: 36530 # This is the default from PublishSymbols@2
+  - name: publishVpackToWindows
+    type: boolean
+    default: false
+
+  - name: pool
+    type: object
+    default:
+      name: SHINE-INT-S # By default, send jobs to the small agent pool.
+      demands: ImageOverride -equals SHINE-VS17-Latest
+
+variables:
+  # If we are building a branch called "release-*", change the NuGet suffix
+  # to "preview". If we don't do that, XES will set the suffix to "release1"
+  # because it truncates the value after the first period.
+  # We also want to disable the suffix entirely if we're Release branded while
+  # on a release branch.
+  # main is special, however. XES ignores main. Since we never produce actual
+  # shipping builds from main, we want to force it to have a beta label as
+  # well.
+  #
+  # In effect:
+  # BRANCH / BRANDING | Release                    | Preview
+  # ------------------|----------------------------|-----------------------------
+  # release-*         | 1.12.20220427              | 1.13.20220427-preview
+  # main              | 1.14.20220427-experimental | 1.14.20220427-experimental
+  # all others        | 1.14.20220427-mybranch     | 1.14.20220427-mybranch
+  ${{ if startsWith(variables['Build.SourceBranchName'], 'release-') }}:
+    ${{ if eq(parameters.branding, 'Release') }}:
+      NoNuGetPackBetaVersion: true
+    ${{ else }}:
+      NuGetPackBetaVersion: preview
+  ${{ elseif eq(variables['Build.SourceBranchName'], 'main') }}:
+    NuGetPackBetaVersion: experimental
+
+resources:
+  repositories:
+  - repository: self
+    type: git
+    ref: main
+
+stages:
+  - stage: Build
+    displayName: Build
+    pool: ${{ parameters.pool }}
+    dependsOn: []
+    jobs:
+      - template: ./job-build-project.yml
+        parameters:
+          pool:
+            name: SHINE-INT-L # Run the compilation on the large agent pool, rather than the default small one.
+            demands: ImageOverride -equals SHINE-VS17-Latest
+          branding: ${{ parameters.branding }}
+          buildTerminal: ${{ parameters.buildTerminal }}
+          buildConPTY: ${{ parameters.buildConPTY }}
+          buildWPF: ${{ parameters.buildWPF }}
+          pgoBuildMode: ${{ parameters.pgoBuildMode }}
+          buildConfigurations: ${{ parameters.buildConfigurations }}
+          buildPlatforms: ${{ parameters.buildPlatforms }}
+          generateSbom: ${{ parameters.generateSbom }}
+          codeSign: ${{ parameters.codeSign }}
+          beforeBuildSteps: # Right before we build, lay down the universal package and localizations
+            - task: PkgESSetupBuild@12
+              displayName: Package ES - Setup Build
+              inputs:
+                disableOutputRedirect: true
+
+            - task: UniversalPackages@0
+              displayName: Download terminal-internal Universal Package
+              inputs:
+                feedListDownload: 2b3f8893-a6e8-411f-b197-a9e05576da48
+                packageListDownload: e82d490c-af86-4733-9dc4-07b772033204
+                versionListDownload: ${{ parameters.terminalInternalPackageVersion }}
+
+            - template: ./steps-fetch-and-prepare-localizations.yml
+              parameters:
+                includePseudoLoc: true
+
+      - ${{ if eq(parameters.buildWPF, true) }}:
+        # Add an Any CPU build flavor for the WPF control bits
+        - template: ./job-build-project.yml
+          parameters:
+            # This job is allowed to run on the default small pool.
+            jobName: BuildWPF
+            branding: ${{ parameters.branding }}
+            buildTerminal: false
+            buildWPFDotNetComponents: true
+            buildConfigurations: ${{ parameters.buildConfigurations }}
+            buildPlatforms:
+              - Any CPU
+            generateSbom: ${{ parameters.generateSbom }}
+            codeSign: ${{ parameters.codeSign }}
+            beforeBuildSteps:
+              - task: PkgESSetupBuild@12
+                displayName: Package ES - Setup Build
+                inputs:
+                  disableOutputRedirect: true
+              # WPF doesn't need the localizations or the universal package, but if it does... put them here.
+
+  - stage: Package
+    displayName: Package
+    pool: ${{ parameters.pool }}
+    dependsOn: [Build]
+    jobs:
+      - ${{ if eq(parameters.buildTerminal, true) }}:
+        - template: ./job-merge-msix-into-bundle.yml
+          parameters:
+            jobName: Bundle
+            branding: ${{ parameters.branding }}
+            buildConfigurations: ${{ parameters.buildConfigurations }}
+            buildPlatforms: ${{ parameters.buildPlatforms }}
+            generateSbom: ${{ parameters.generateSbom }}
+            codeSign: ${{ parameters.codeSign }}
+
+      - ${{ if eq(parameters.buildConPTY, true) }}:
+        - template: ./job-package-conpty.yml
+          parameters:
+            buildConfigurations: ${{ parameters.buildConfigurations }}
+            buildPlatforms: ${{ parameters.buildPlatforms }}
+            generateSbom: ${{ parameters.generateSbom }}
+            codeSign: ${{ parameters.codeSign }}
+
+      - ${{ if eq(parameters.buildWPF, true) }}:
+        - template: ./job-build-package-wpf.yml
+          parameters:
+            buildConfigurations: ${{ parameters.buildConfigurations }}
+            buildPlatforms: ${{ parameters.buildPlatforms }}
+            generateSbom: ${{ parameters.generateSbom }}
+            codeSign: ${{ parameters.codeSign }}
+
+  - stage: Publish
+    displayName: Publish
+    pool: ${{ parameters.pool }}
+    dependsOn: [Build, Package]
+    jobs:
+      # We only support the vpack for Release builds that include Terminal
+      - ${{ if and(containsValue(parameters.buildConfigurations, 'Release'), parameters.buildTerminal, parameters.publishVpackToWindows) }}:
+        - template: ./job-submit-windows-vpack.yml
+          parameters:
+            buildConfiguration: Release
+            generateSbom: ${{ parameters.generateSbom }}
+
+      - template: ./job-publish-symbols.yml
+        parameters:
+          includePublicSymbolServer: ${{ parameters.publishSymbolsToPublic }}
+          symbolExpiryTime: ${{ parameters.symbolExpiryTime }}
+
+...