Allow the user to set the package version when running the azdo pipeline (#8151)

* Allow the user to set the package version when running the azdo pipeline

* Default value for a string param can't be empty string

* pass ptvsPackageVersion into build template

* Give package version a default value in the build template to avoid breaking other callers

* Fix syntax error

Author: AdamYoblick

Build/debugpy-version.txt

@@ -1 +1 @@
-1.8.11
+1.8.12

Build/templates/build.yml

@@ -1,3 +1,8 @@
+parameters:
+- name: ptvsPackageVersion
+  type: string
+  default: $(Build.BuildNumber)
+
 steps:
 
   # Build the product
@@ -8,7 +13,9 @@ steps:
       msbuildVersion: $(MsBuildVersion)
       platform: $(Platform)
       configuration: $(BuildConfiguration)
-      msbuildArguments: '/p:VSTarget=$(VSTarget) /bl:$(Build.SourcesDirectory)\logs\BuildProduct.binlog'
+      msbuildArguments: ' /p:VSTarget=$(VSTarget) 
+                          /p:BuildNumber=${{ parameters.ptvsPackageVersion }} 
+                          /bl:$(Build.SourcesDirectory)\logs\BuildProduct.binlog'
 
   # The publish SBOM tasks have been removed because they are generated and published automatically by the pipeline
   # https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/1es-pipeline-templates/features/sbom
@@ -33,7 +40,9 @@ steps:
       msbuildVersion: $(MsBuildVersion)
       platform: $(Platform)
       configuration: $(BuildConfiguration)
-      msbuildArguments: '/p:VSTarget=$(VSTarget) /bl:$(Build.SourcesDirectory)\logs\BuildTests.binlog'
+      msbuildArguments: ' /p:VSTarget=$(VSTarget) 
+                          /p:BuildNumber=${{ parameters.ptvsPackageVersion }} 
+                          /bl:$(Build.SourcesDirectory)\logs\BuildTests.binlog'
 
   # Build the installer
   - task: MSBuild@1
@@ -45,6 +54,7 @@ steps:
       configuration: $(BuildConfiguration)
       msbuildArguments: ' /p:SkipProduct=true 
                           /p:VSTarget=$(VSTarget) 
+                          /p:BuildNumber=${{ parameters.ptvsPackageVersion }} 
                           /p:BUILD_BINARIESDIRECTORY=$(Build.BinariesDirectory)
                           /p:BUILD_STAGINGDIRECTORY=$(Build.StagingDirectory) 
                           /bl:$(Build.SourcesDirectory)\logs\BuildInstaller.binlog'

azure-pipelines.yml

@@ -4,21 +4,33 @@
 # The pipeline extends v1/1ES.Official.PipelineTemplate.yml@1ESPipelineTemplates from 1esPipelines repository defined in resources section.
 
 parameters:
+
 - name: pylanceVersion
   displayName: Pylance Version
   type: string
   default: latest
+
 - name: pylanceReleaseType
   displayName: Pylance Release Type
   type: string
   default: stable
   values:
     - stable
     - preview
+
 - name: debugpyVersion
   displayName: Debugpy Version
   type: string
   default: latest
+
+# This is the version that the PTVS package currently being built will have.
+# If this value is set to 'currentBuildNumber' will default to $(Build.BuildNumber).
+# But this parameter can be used to overwrite the version number if needed.
+- name: ptvsPackageVersion
+  displayName: PTVS Package Version
+  type: string
+  default: currentBuildNumber
+
 - name: skipGlassCache
   displayName: Skip Glass Cache
   type: boolean
@@ -92,6 +104,13 @@ variables:
     ${{ else }}:
       value: ${{ parameters.pylanceReleaseType }}
 
+  # If the vs package version is not specified, use the build number
+  - name: ptvsPackageVersionVar
+    ${{ if eq(parameters.ptvsPackageVersion, 'currentBuildNumber') }}:
+      value: $(Build.BuildNumber)
+    ${{ else }}:
+      value: ${{ parameters.ptvsPackageVersion }}
+
   # Import variables from PTVS-Dev17 variable group
   - group: PTVS-Dev17
 
@@ -185,6 +204,8 @@ extends:
 
         # Build and publish logs    
         - template: /Build/templates/build.yml@self
+          parameters:
+            ptvsPackageVersion: ${{ variables.ptvsPackageVersionVar }}
 
         # Non-PR steps
         - ${{ if notin(variables['Build.Reason'], 'PullRequest') }}: