mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-11-27 23:19:13 +08:00
ad1f20408c
This pull request rewrites the entire Azure DevOps build system. The guiding principles behind this rewrite are: - No pipeline definitions should contain steps (or tasks) directly. - All jobs should be in template files. - Any set of steps that is reused across multiple jobs must be in template files. - All artifact names can be customized (via a property called `artifactStem` on all templates that produce or consume artifacts). - No compilation happens outside of the "Build" phase, to consolidate the production and indexing of PDBs. - All step and job templates are named with `step` or `job` _first_, which disambiguates them in the templates directory. - Most jobs can be run on different `pool`s, so that we can put expensive jobs on expensive build agents and cheap jobs on cheap build agents. Some jobs handle pool selection on their own, however. Our original build pipelines used the `VSBuild` task _all over the place._ This resulted in PowerToys being built in myriad ways, different for every pipeline. There was an attempt at standardization early on, where `ci.yml` consumed jobs and steps templates... but when `release.yml` was added, all of that went out the window. It's the same story as Terminal (https://github.com/microsoft/terminal/pull/15808). The new pipelines are consistent and focus on a small, well-defined set of jobs: - `job-build-project` - This is the big one! - Takes a list of build configurations and platforms. - Produces an artifact named `build-PLATFORM-CONFIG` for the entire matrix of possibilities. - Builds all of the installers. - Optionally signs the output (all of the output). - Admittedly has a lot going on. - `job-test-project` - Takes **one** build config and **one** platform. - Consumes `build-PLATFORM-CONFIG` - Selects its own pools (hardcoded) because it knows about architectures and must choose the right agent arch. - Runs tests (directly on the build agent). - `job-publish-symbols-using-symbolrequestprod-api` - Consumes `**/*.pdb` from all prior build phases. - Uploads all PDBs in one artifact to Azure DevOps - Uses Microsoft's internal symbol publication REST API to submit stripped symbols to MSDL for public consumption. Finally, this pull request has some additional benefits: - Symbols are published to the private and public feeds at the same time, in the same step. They should be available in the public symbol server for public folks to debug against! - We have all the underpinnings necessary to run tests on ARM64 build agents. - Right now, `ScreenResolutionUtility` is broken - I had to introduce a custom version of `UseDotNet` which would install the right architecture (🤦); see https://github.com/microsoft/azure-pipelines-tasks/issues/20300. - All dotnet and nuget versioning is consolidated into a small set of step templates. - This will provide a great place for us to handle versioning changes later, since all versioning happens in one place.
117 lines
4.3 KiB
YAML
117 lines
4.3 KiB
YAML
parameters:
|
|
- name: includePublicSymbolServer
|
|
type: boolean
|
|
default: false
|
|
- name: pool
|
|
type: object
|
|
default: []
|
|
- name: dependsOn
|
|
type: object
|
|
default: null
|
|
- name: versionNumber
|
|
type: string
|
|
default: '0.0.1'
|
|
- name: artifactStem
|
|
type: string
|
|
default: ''
|
|
- name: jobName
|
|
type: string
|
|
default: PublishSymbols
|
|
- name: symbolExpiryTime
|
|
type: string
|
|
default: 36530 # This is the default from PublishSymbols@2
|
|
- name: variables
|
|
type: object
|
|
default: {}
|
|
- name: subscription
|
|
type: string
|
|
- name: symbolProject
|
|
type: string
|
|
|
|
jobs:
|
|
- job: ${{ parameters.jobName }}
|
|
${{ if ne(length(parameters.pool), 0) }}:
|
|
pool: ${{ parameters.pool }}
|
|
${{ if eq(parameters.includePublicSymbolServer, true) }}:
|
|
displayName: Publish Symbols to Internal and MSDL
|
|
${{ else }}:
|
|
displayName: Publish Symbols Internally
|
|
dependsOn: ${{ parameters.dependsOn }}
|
|
variables:
|
|
${{ insert }}: ${{ parameters.variables }}
|
|
SymbolsArtifactName: "PowerToys_${{parameters.versionNumber}}_$(Build.BuildNumber)"
|
|
steps:
|
|
- checkout: self
|
|
clean: true
|
|
fetchDepth: 1
|
|
fetchTags: false # Tags still result in depth > 1 fetch; we don't need them here
|
|
submodules: true
|
|
persistCredentials: True
|
|
|
|
- task: DownloadPipelineArtifact@2
|
|
displayName: Download all PDBs from all prior build phases
|
|
inputs:
|
|
itemPattern: '**/*.pdb'
|
|
targetPath: '$(Build.SourcesDirectory)/symbolStaging'
|
|
|
|
- powershell: |-
|
|
Get-PackageProvider -Name NuGet -ForceBootstrap
|
|
Install-Module -Verbose -AllowClobber -Force Az.Accounts, Az.Storage, Az.Network, Az.Resources, Az.Compute
|
|
displayName: Install Azure Module Dependencies
|
|
|
|
# Transit the Azure token from the Service Connection into a secret variable for the rest of the pipeline to use.
|
|
- task: AzurePowerShell@5
|
|
displayName: Generate an Azure Token
|
|
inputs:
|
|
azureSubscription: ${{ parameters.subscription }}
|
|
azurePowerShellVersion: LatestVersion
|
|
pwsh: true
|
|
ScriptType: InlineScript
|
|
Inline: |-
|
|
$AzToken = (Get-AzAccessToken -ResourceUrl api://30471ccf-0966-45b9-a979-065dbedb24c1).Token
|
|
Write-Host "##vso[task.setvariable variable=SymbolAccessToken;issecret=true]$AzToken"
|
|
|
|
|
|
- task: PublishSymbols@2
|
|
displayName: Publish Symbols (to current Azure DevOps tenant)
|
|
continueOnError: True
|
|
inputs:
|
|
SymbolsFolder: '$(Build.SourcesDirectory)/symbolStaging'
|
|
SearchPattern: '**/*.pdb'
|
|
IndexSources: false
|
|
DetailedLog: true
|
|
SymbolsMaximumWaitTime: 30
|
|
SymbolServerType: 'TeamServices'
|
|
SymbolsProduct: 'PowerToys Converged Symbols'
|
|
SymbolsVersion: '${{ parameters.versionNumber }}'
|
|
SymbolsArtifactName: $(SymbolsArtifactName)
|
|
SymbolExpirationInDays: ${{ parameters.symbolExpiryTime }}
|
|
env:
|
|
LIB: $(Build.SourcesDirectory)
|
|
|
|
- pwsh: |-
|
|
# Prepare the defaults for IRM
|
|
$PSDefaultParameterValues['Invoke-RestMethod:Headers'] = @{ Authorization = "Bearer $(SymbolAccessToken)" }
|
|
$PSDefaultParameterValues['Invoke-RestMethod:ContentType'] = "application/json"
|
|
$PSDefaultParameterValues['Invoke-RestMethod:Method'] = "POST"
|
|
|
|
$BaseUri = "https://symbolrequestprod.trafficmanager.net/projects/${{ parameters.symbolProject }}/requests"
|
|
|
|
# Prepare the request
|
|
$expiration = (Get-Date).Add([TimeSpan]::FromDays(${{ parameters.symbolExpiryTime }}))
|
|
$createRequestBody = @{
|
|
requestName = "$(SymbolsArtifactName)";
|
|
expirationTime = $expiration.ToString();
|
|
}
|
|
Write-Host "##[debug]Starting request $($createRequestBody.requestName) with expiration date of $($createRequestBody.expirationTime)"
|
|
Invoke-RestMethod -Uri "$BaseUri" -Body ($createRequestBody | ConvertTo-Json -Compress) -Verbose
|
|
|
|
# Request symbol publication
|
|
$publishRequestBody = @{
|
|
publishToInternalServer = $true;
|
|
publishToPublicServer = $${{ parameters.includePublicSymbolServer }};
|
|
}
|
|
Write-Host "##[debug]Submitting request $($createRequestBody.requestName) ($($publishRequestBody | ConvertTo-Json -Compress))"
|
|
Invoke-RestMethod -Uri "$BaseUri/$($createRequestBody.requestName)" -Body ($publishRequestBody | ConvertTo-Json -Compress) -Verbose
|
|
displayName: Publish Symbols using internal REST API
|