Get the OneBranch Official pipeline working (#3994)

Author: paulmedynski

.github/instructions/onebranch-pipeline-design.instructions.md

@@ -189,7 +189,7 @@ The release stage is gated and only executes on demand when at least one release
 - **Publish jobs**: Each package has a conditional publish job that is included at compile time only when its parameter is `true`:
   ```yaml
   - ${{ if eq(parameters.releaseXxx, true) }}:
-    - template: /eng/pipelines/common/templates/jobs/publish-nuget-package-job.yml@self
+    - template: /eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml@self
   ```
 - **Environment variables**: Stage sets `ob_release_usedeploymentjob: true` for OneBranch integration:
   - Official: `ob_release_environment: 'NuGet-Production'`
@@ -308,7 +308,7 @@ parameters:
     type: boolean
     default: false
 
-  - name: releaseExtAzure
+  - name: releaseAzure
     displayName: 'Release Microsoft.Data.SqlClient.Extensions.Azure'
     type: boolean
     default: false

eng/pipelines/common/templates/jobs/run-tests-package-reference-job.yml

@@ -94,7 +94,7 @@ jobs:
           ob_sdl_apiscan_versionNumber: '${{ parameters.akvAssemblyFileVersion }}'
 
       steps:
-          - template: /eng/pipelines/steps/script-output-environment-variables-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/script-output-environment-variables-step.yml@self
 
           - powershell: |
                 $jsonParams = '${{ convertToJson(parameters) }}' -replace '\\', '\\'
@@ -121,15 +121,15 @@ jobs:
 
           # Perform analysis before building, since this step will clobber build
           # output.
-          - template: /eng/pipelines/steps/roslyn-analyzers-akv-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/roslyn-analyzers-akv-step.yml@self
             parameters:
                 akvPackageVersion: '${{ parameters.akvPackageVersion }}'
                 buildConfiguration: '${{ parameters.buildConfiguration }}'
                 mdsPackageVersion: '${{ parameters.mdsPackageVersion }}'
                 loggingPackageVersion: '${{ parameters.loggingPackageVersion }}'
                 abstractionsPackageVersion: '${{ parameters.abstractionsPackageVersion }}'
 
-          - template: /eng/pipelines/steps/compound-build-akv-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/compound-build-akv-step.yml@self
             parameters:
                 akvAssemblyFileVersion: '${{ parameters.akvAssemblyFileVersion }}'
                 akvPackageVersion: '${{ parameters.akvPackageVersion }}'
@@ -139,15 +139,15 @@ jobs:
                 abstractionsPackageVersion: '${{ parameters.abstractionsPackageVersion }}'
 
           - ${{ each targetFramework in parameters.targetFrameworks }}:
-              - template: /eng/pipelines/steps/compound-extract-akv-apiscan-files-step.yml@self
+              - template: /eng/pipelines/onebranch/steps/compound-extract-akv-apiscan-files-step.yml@self
                 parameters:
                     buildConfiguration: '${{ parameters.buildConfiguration }}'
                     dllPath: '${{ parameters.apiScanDllPath }}'
                     pdbPath: '${{ parameters.apiScanPdbPath }}'
                     referenceType: Package
                     targetFramework: '${{ targetFramework }}'
 
-          - template: /eng/pipelines/steps/compound-esrp-dll-signing-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/compound-esrp-dll-signing-step.yml@self
             parameters:
                 appRegistrationClientId: '${{ parameters.appRegistrationClientId }}'
                 appRegistrationTenantId: '${{ parameters.appRegistrationTenantId }}'
@@ -157,7 +157,7 @@ jobs:
                 esrpConnectedServiceName: '${{ parameters.esrpConnectedServiceName }}'
                 pattern: 'Microsoft.Data.SqlClient.AlwaysEncrypted.*.dll'
 
-          - template: /eng/pipelines/steps/compound-nuget-pack-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/compound-nuget-pack-step.yml@self
             parameters:
                 buildConfiguration: '${{ parameters.buildConfiguration }}'
                 generateSymbolsPackage: true    # Always generate symbols, even if they are not published
@@ -167,7 +167,7 @@ jobs:
                 referenceType: Package
                 properties: MdsPackageVersion=${{ parameters.mdsPackageVersion }};LoggingPackageVersion=${{ parameters.loggingPackageVersion }};AbstractionsPackageVersion=${{ parameters.abstractionsPackageVersion }}
 
-          - template: /eng/pipelines/steps/compound-esrp-nuget-signing-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/compound-esrp-nuget-signing-step.yml@self
             parameters:
                 appRegistrationClientId: '${{ parameters.appRegistrationClientId }}'
                 appRegistrationTenantId: '${{ parameters.appRegistrationTenantId }}'
@@ -177,7 +177,7 @@ jobs:
                 esrpConnectedServiceName: '${{ parameters.esrpConnectedServiceName }}'
 
           - ${{ if parameters.publishSymbols }}:
-            - template: /eng/pipelines/steps/compound-publish-symbols-step.yml@self
+            - template: /eng/pipelines/onebranch/steps/compound-publish-symbols-step.yml@self
               parameters:
                   artifactName: 'akv_symbols_$(System.TeamProject)_$(Build.Repository.Name)_$(Build.SourceBranchName)_${{ parameters.akvPackageVersion }}_$(System.TimelineId)'
                   azureSubscription: '${{ parameters.symbolsAzureSubscription }}'

eng/pipelines/libraries/build-variables.yml

@@ -114,7 +114,7 @@ jobs:
       packTarget: ${{ coalesce(parameters.packTarget, format('Pack{0}', parameters.packageName)) }}
 
     steps:
-      - template: /eng/pipelines/steps/script-output-environment-variables-step.yml@self
+      - template: /eng/pipelines/onebranch/steps/script-output-environment-variables-step.yml@self
 
       # Download any pipeline artifacts this package depends on.
       - ${{ each artifact in parameters.downloadArtifacts }}:
@@ -143,14 +143,14 @@ jobs:
           setupCommandLinePicker: vs2022
 
       # Build the package, producing DLLs only (no NuGet package yet).
-      - template: /eng/pipelines/steps/compound-build-csproj-step.yml@self
+      - template: /eng/pipelines/onebranch/steps/compound-build-csproj-step.yml@self
         parameters:
           buildTarget: $(buildTarget)
           buildConfiguration: ${{ parameters.buildConfiguration }}
           versionProperties: ${{ parameters.versionProperties }}
 
       # ESRP sign the DLLs.
-      - template: /eng/pipelines/steps/compound-esrp-dll-signing-step.yml@self
+      - template: /eng/pipelines/onebranch/steps/compound-esrp-dll-signing-step.yml@self
         parameters:
           appRegistrationClientId: ${{ parameters.appRegistrationClientId }}
           appRegistrationTenantId: ${{ parameters.appRegistrationTenantId }}
@@ -181,14 +181,14 @@ jobs:
           flattenFolders: false
 
       # Pack the signed DLLs into NuGet package (NoBuild=true).
-      - template: /eng/pipelines/steps/compound-pack-csproj-step.yml@self
+      - template: /eng/pipelines/onebranch/steps/compound-pack-csproj-step.yml@self
         parameters:
           packTarget: $(packTarget)
           buildConfiguration: ${{ parameters.buildConfiguration }}
           versionProperties: ${{ parameters.versionProperties }}
 
       # ESRP sign the NuGet package.
-      - template: /eng/pipelines/steps/compound-esrp-nuget-signing-step.yml@self
+      - template: /eng/pipelines/onebranch/steps/compound-esrp-nuget-signing-step.yml@self
         parameters:
           appRegistrationClientId: ${{ parameters.appRegistrationClientId }}
           appRegistrationTenantId: ${{ parameters.appRegistrationTenantId }}
@@ -199,7 +199,7 @@ jobs:
 
       # Publish symbols to servers
       - ${{ if eq(parameters.publishSymbols, true) }}:
-          - template: /eng/pipelines/common/templates/steps/publish-symbols-step.yml@self
+          - template: /eng/pipelines/onebranch/steps/publish-symbols-step.yml@self
             parameters:
               packageFullName: ${{ parameters.packageFullName }}
               packageVersion: ${{ parameters.packageVersion }}

…ipelines/jobs/build-akv-official-job.yml …nebranch/jobs/build-akv-official-job.ymleng/pipelines/jobs/build-akv-official-job.yml renamed to eng/pipelines/onebranch/jobs/build-akv-official-job.yml eng/pipelines/jobs/build-akv-official-job.yml renamed to eng/pipelines/onebranch/jobs/build-akv-official-job.yml

@@ -68,10 +68,10 @@ jobs:
       msbuildArguments: -t:BuildTools
 
   # Perform analysis before building, since this step will clobber build output.
-  - template: /eng/pipelines/common/templates/steps/code-analyze-step.yml@self
+  - template: /eng/pipelines/onebranch/steps/code-analyze-step.yml@self
 
   # Build MDS, producing signed DLLs.
-  - template: /eng/pipelines/common/templates/steps/build-all-configurations-signed-dlls-step.yml@self
+  - template: /eng/pipelines/onebranch/steps/build-all-configurations-signed-dlls-step.yml@self
     parameters:
       # These variables are sourced from common-variables.yml.
       abstractionsAssemblyFileVersion: $(abstractionsAssemblyFileVersion)
@@ -81,7 +81,7 @@ jobs:
       mdsAssemblyFileVersion: $(mdsAssemblyFileVersion)
       mdsPackageVersion: $(mdsPackageVersion)
 
-  - template: /eng/pipelines/common/templates/steps/esrp-code-signing-step.yml@self
+  - template: /eng/pipelines/onebranch/steps/esrp-code-signing-step.yml@self
     parameters:
       artifactType: dll
 
@@ -97,7 +97,7 @@ jobs:
       properties: 'AbstractionsPackageVersion=$(abstractionsPackageVersion);LoggingPackageVersion=$(loggingPackageVersion)'
       referenceType: Package
 
-  - template: /eng/pipelines/common/templates/steps/esrp-code-signing-step.yml@self
+  - template: /eng/pipelines/onebranch/steps/esrp-code-signing-step.yml@self
     parameters:
       artifactType: pkg
 
@@ -123,7 +123,7 @@ jobs:
 
   # Publish symbols to servers
   - ${{ if eq(parameters.publishSymbols, true) }}:
-    - template: /eng/pipelines/common/templates/steps/publish-symbols-step.yml@self
+    - template: /eng/pipelines/onebranch/steps/publish-symbols-step.yml@self
       parameters:
         packageFullName: Microsoft.Data.SqlClient
         packageVersion: $(mdsPackageVersion)

…jobs/build-signed-csproj-package-job.yml …jobs/build-signed-csproj-package-job.ymleng/pipelines/jobs/build-signed-csproj-package-job.yml renamed to eng/pipelines/onebranch/jobs/build-signed-csproj-package-job.yml eng/pipelines/jobs/build-signed-csproj-package-job.yml renamed to eng/pipelines/onebranch/jobs/build-signed-csproj-package-job.yml

@@ -24,7 +24,7 @@ jobs:
     vmImage: 'ADO-MMS22-SQL19'
 
   variables: # More settings at https://aka.ms/obpipelines/yaml/jobs
-  - template: /eng/pipelines/libraries/mds-validation-variables.yml@self
+  - template: /eng/pipelines/onebranch/variables/sqlclient-validation-variables.yml@self
 
   - name: pathToDownloadedNuget # path to the downloaded nuget files
     value: $(Pipeline.Workspace)\${{parameters.artifactName }}

…plates/jobs/build-signed-package-job.yml …s/build-signed-sqlclient-package-job.ymleng/pipelines/common/templates/jobs/build-signed-package-job.yml renamed to eng/pipelines/onebranch/jobs/build-signed-sqlclient-package-job.yml eng/pipelines/common/templates/jobs/build-signed-package-job.yml renamed to eng/pipelines/onebranch/jobs/build-signed-sqlclient-package-job.yml

@@ -84,7 +84,7 @@ parameters:
     default: false
 
   # Release the Microsoft.Data.SqlClient.Extensions.Azure package.
-  - name: releaseExtAzure
+  - name: releaseAzure
     displayName: Release Microsoft.Data.SqlClient.Extensions.Azure
     type: boolean
     default: false
@@ -96,7 +96,7 @@ parameters:
     default: false
 
 variables:
-  - template: /eng/pipelines/libraries/onebranch-variables.yml@self
+  - template: /eng/pipelines/onebranch/variables/onebranch-variables.yml@self
 
 resources:
   repositories:
@@ -157,22 +157,27 @@ extends:
         tsaOptionsPath: $(REPO_ROOT)\.config\tsaoptions.json
         disableLegacyManifest: true
     stages:
-      - template: /eng/pipelines/stages/sqlclient-onebranch-stages.yml@self
+      - template: /eng/pipelines/onebranch/stages/build-stages.yml@self
         parameters:
           debug: ${{ parameters.debug }}
-          # This is not an official pipeline.
-          isOfficial: false
           isPreview: ${{ parameters.isPreview }}
           publishSymbols: ${{ parameters.publishSymbols }}
-          # Non-Official pipelines must always be a dry-run.
-          releaseDryRun: true
-          testJobTimeout: ${{ parameters.testJobTimeout }}
           buildSqlServerServer: ${{ parameters.buildSqlServerServer }}
           buildSqlClient: ${{ parameters.buildSqlClient }}
           buildAKVProvider: ${{ parameters.buildAKVProvider }}
+
+      - template: /eng/pipelines/onebranch/stages/release-stages.yml@self
+        parameters:
+          debug: ${{ parameters.debug }}
+          # Non-official pipelines must always be a dry run.
+          isDryRun: true
+          # This is _not_ official pipeline.
+          isOfficial: false
+          stageNameSuffix: test
+          stageDisplayName: Release Test (Dry Run)
           releaseSqlServerServer: ${{ parameters.releaseSqlServerServer }}
           releaseLogging: ${{ parameters.releaseLogging }}
           releaseAbstractions: ${{ parameters.releaseAbstractions }}
           releaseSqlClient: ${{ parameters.releaseSqlClient }}
-          releaseExtAzure: ${{ parameters.releaseExtAzure }}
+          releaseAzure: ${{ parameters.releaseAzure }}
           releaseAKVProvider: ${{ parameters.releaseAKVProvider }}

…lates/jobs/publish-nuget-package-job.yml …ranch/jobs/publish-nuget-package-job.ymleng/pipelines/common/templates/jobs/publish-nuget-package-job.yml renamed to eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml eng/pipelines/common/templates/jobs/publish-nuget-package-job.yml renamed to eng/pipelines/onebranch/jobs/publish-nuget-package-job.yml

@@ -105,7 +105,7 @@ parameters:
     default: false
 
   # Release the Microsoft.Data.SqlClient.Extensions.Azure package.
-  - name: releaseExtAzure
+  - name: releaseAzure
     displayName: Release Microsoft.Data.SqlClient.Extensions.Azure
     type: boolean
     default: false
@@ -117,7 +117,7 @@ parameters:
     default: false
 
 variables:
-  - template: /eng/pipelines/libraries/onebranch-variables.yml@self
+  - template: /eng/pipelines/onebranch/variables/onebranch-variables.yml@self
 
 resources:
   repositories:
@@ -182,21 +182,29 @@ extends:
         tsaOptionsPath: $(REPO_ROOT)\.config\tsaoptions.json
         disableLegacyManifest: true
     stages:
-      - template: /eng/pipelines/stages/sqlclient-onebranch-stages.yml@self
+      - template: /eng/pipelines/onebranch/stages/build-stages.yml@self
         parameters:
           debug: ${{ parameters.debug }}
-          # This is an official pipeline.
-          isOfficial: true
           isPreview: ${{ parameters.isPreview }}
           publishSymbols: ${{ parameters.publishSymbols }}
-          releaseDryRun: ${{ parameters.releaseDryRun }}
-          testJobTimeout: ${{ parameters.testJobTimeout }}
           buildSqlServerServer: ${{ parameters.buildSqlServerServer }}
           buildSqlClient: ${{ parameters.buildSqlClient }}
           buildAKVProvider: ${{ parameters.buildAKVProvider }}
+
+      - template: /eng/pipelines/onebranch/stages/release-stages.yml@self
+        parameters:
+          debug: ${{ parameters.debug }}
+          isDryRun: ${{ parameters.releaseDryRun }}
+          # This is an official pipeline.
+          isOfficial: true
+          stageNameSuffix: production
+          ${{ if eq(parameters.releaseDryRun, true) }}:
+            stageDisplayName: Release Production (Dry Run)
+          ${{ else }}:
+            stageDisplayName: Release Production
           releaseSqlServerServer: ${{ parameters.releaseSqlServerServer }}
           releaseLogging: ${{ parameters.releaseLogging }}
           releaseAbstractions: ${{ parameters.releaseAbstractions }}
           releaseSqlClient: ${{ parameters.releaseSqlClient }}
-          releaseExtAzure: ${{ parameters.releaseExtAzure }}
+          releaseAzure: ${{ parameters.releaseAzure }}
           releaseAKVProvider: ${{ parameters.releaseAKVProvider }}