msbuild

1
# Please remember to update the documentation if you make changes to these parameters!
2
parameters:
3
  HelixSource: 'pr/default'              # required -- sources must start with pr/, official/, prodcon/, or agent/
4
  HelixType: 'tests/default/'            # required -- Helix telemetry which identifies what type of data this is; should include "test" for clarity and must end in '/'
5
  HelixBuild: $(Build.BuildNumber)       # required -- the build number Helix will use to identify this -- automatically set to the AzDO build number
6
  HelixTargetQueues: ''                  # required -- semicolon-delimited list of Helix queues to test on; see https://helix.dot.net/ for a list of queues
7
  HelixAccessToken: ''                   # required -- access token to make Helix API requests; should be provided by the appropriate variable group
8
  HelixConfiguration: ''                 # optional -- additional property attached to a job
9
  HelixPreCommands: ''                   # optional -- commands to run before Helix work item execution
10
  HelixPostCommands: ''                  # optional -- commands to run after Helix work item execution
11
  WorkItemDirectory: ''                  # optional -- a payload directory to zip up and send to Helix; requires WorkItemCommand; incompatible with XUnitProjects
12
  WorkItemCommand: ''                    # optional -- a command to execute on the payload; requires WorkItemDirectory; incompatible with XUnitProjects
13
  WorkItemTimeout: ''                    # optional -- a timeout in TimeSpan.Parse-ready value (e.g. 00:02:00) for the work item command; requires WorkItemDirectory; incompatible with XUnitProjects
14
  CorrelationPayloadDirectory: ''        # optional -- a directory to zip up and send to Helix as a correlation payload
15
  XUnitProjects: ''                      # optional -- semicolon-delimited list of XUnitProjects to parse and send to Helix; requires XUnitRuntimeTargetFramework, XUnitPublishTargetFramework, XUnitRunnerVersion, and IncludeDotNetCli=true
16
  XUnitWorkItemTimeout: ''               # optional -- the workitem timeout in seconds for all workitems created from the xUnit projects specified by XUnitProjects
17
  XUnitPublishTargetFramework: ''        # optional -- framework to use to publish your xUnit projects
18
  XUnitRuntimeTargetFramework: ''        # optional -- framework to use for the xUnit console runner
19
  XUnitRunnerVersion: ''                 # optional -- version of the xUnit nuget package you wish to use on Helix; required for XUnitProjects
20
  IncludeDotNetCli: false                # optional -- true will download a version of the .NET CLI onto the Helix machine as a correlation payload; requires DotNetCliPackageType and DotNetCliVersion
21
  DotNetCliPackageType: ''               # optional -- either 'sdk', 'runtime' or 'aspnetcore-runtime'; determines whether the sdk or runtime will be sent to Helix; see https://raw.githubusercontent.com/dotnet/core/main/release-notes/releases-index.json
22
  DotNetCliVersion: ''                   # optional -- version of the CLI to send to Helix; based on this: https://raw.githubusercontent.com/dotnet/core/main/release-notes/releases-index.json
23
  WaitForWorkItemCompletion: true        # optional -- true will make the task wait until work items have been completed and fail the build if work items fail. False is "fire and forget."
24
  IsExternal: false                      # [DEPRECATED] -- doesn't do anything, jobs are external if HelixAccessToken is empty and Creator is set
25
  HelixBaseUri: 'https://helix.dot.net/' # optional -- sets the Helix API base URI (allows targeting https://helix.int-dot.net )
26
  Creator: ''                            # optional -- if the build is external, use this to specify who is sending the job
27
  DisplayNamePrefix: 'Run Tests'         # optional -- rename the beginning of the displayName of the steps in AzDO 
28
  condition: succeeded()                 # optional -- condition for step to execute; defaults to succeeded()
29
  continueOnError: false                 # optional -- determines whether to continue the build if the step errors; defaults to false
30

31
steps:
32
  - powershell: 'powershell "$env:BUILD_SOURCESDIRECTORY\eng\common\msbuild.ps1 $env:BUILD_SOURCESDIRECTORY\eng\common\helixpublish.proj /restore /p:TreatWarningsAsErrors=false /t:Test /bl:$env:BUILD_SOURCESDIRECTORY\artifacts\log\$env:BuildConfig\SendToHelix.binlog"'
33
    displayName: ${{ parameters.DisplayNamePrefix }} (Windows)
34
    env:
35
      BuildConfig: $(_BuildConfig)
36
      HelixSource: ${{ parameters.HelixSource }}
37
      HelixType: ${{ parameters.HelixType }}
38
      HelixBuild: ${{ parameters.HelixBuild }}
39
      HelixConfiguration:  ${{ parameters.HelixConfiguration }}
40
      HelixTargetQueues: ${{ parameters.HelixTargetQueues }}
41
      HelixAccessToken: ${{ parameters.HelixAccessToken }}
42
      HelixPreCommands: ${{ parameters.HelixPreCommands }}
43
      HelixPostCommands: ${{ parameters.HelixPostCommands }}
44
      WorkItemDirectory: ${{ parameters.WorkItemDirectory }}
45
      WorkItemCommand: ${{ parameters.WorkItemCommand }}
46
      WorkItemTimeout: ${{ parameters.WorkItemTimeout }}
47
      CorrelationPayloadDirectory: ${{ parameters.CorrelationPayloadDirectory }}
48
      XUnitProjects: ${{ parameters.XUnitProjects }}
49
      XUnitWorkItemTimeout: ${{ parameters.XUnitWorkItemTimeout }}
50
      XUnitPublishTargetFramework: ${{ parameters.XUnitPublishTargetFramework }}
51
      XUnitRuntimeTargetFramework: ${{ parameters.XUnitRuntimeTargetFramework }}
52
      XUnitRunnerVersion: ${{ parameters.XUnitRunnerVersion }}
53
      IncludeDotNetCli: ${{ parameters.IncludeDotNetCli }}
54
      DotNetCliPackageType: ${{ parameters.DotNetCliPackageType }}
55
      DotNetCliVersion: ${{ parameters.DotNetCliVersion }}
56
      WaitForWorkItemCompletion: ${{ parameters.WaitForWorkItemCompletion }}
57
      HelixBaseUri: ${{ parameters.HelixBaseUri }}
58
      Creator: ${{ parameters.Creator }}
59
      SYSTEM_ACCESSTOKEN: $(System.AccessToken)
60
    condition: and(${{ parameters.condition }}, eq(variables['Agent.Os'], 'Windows_NT'))
61
    continueOnError: ${{ parameters.continueOnError }}
62
  - script: $BUILD_SOURCESDIRECTORY/eng/common/msbuild.sh $BUILD_SOURCESDIRECTORY/eng/common/helixpublish.proj /restore /p:TreatWarningsAsErrors=false /t:Test /bl:$BUILD_SOURCESDIRECTORY/artifacts/log/$BuildConfig/SendToHelix.binlog
63
    displayName: ${{ parameters.DisplayNamePrefix }} (Unix)
64
    env:
65
      BuildConfig: $(_BuildConfig)
66
      HelixSource: ${{ parameters.HelixSource }}
67
      HelixType: ${{ parameters.HelixType }}
68
      HelixBuild: ${{ parameters.HelixBuild }}
69
      HelixConfiguration:  ${{ parameters.HelixConfiguration }}
70
      HelixTargetQueues: ${{ parameters.HelixTargetQueues }}
71
      HelixAccessToken: ${{ parameters.HelixAccessToken }}
72
      HelixPreCommands: ${{ parameters.HelixPreCommands }}
73
      HelixPostCommands: ${{ parameters.HelixPostCommands }}
74
      WorkItemDirectory: ${{ parameters.WorkItemDirectory }}
75
      WorkItemCommand: ${{ parameters.WorkItemCommand }}
76
      WorkItemTimeout: ${{ parameters.WorkItemTimeout }}
77
      CorrelationPayloadDirectory: ${{ parameters.CorrelationPayloadDirectory }}
78
      XUnitProjects: ${{ parameters.XUnitProjects }}
79
      XUnitWorkItemTimeout: ${{ parameters.XUnitWorkItemTimeout }}
80
      XUnitPublishTargetFramework: ${{ parameters.XUnitPublishTargetFramework }}
81
      XUnitRuntimeTargetFramework: ${{ parameters.XUnitRuntimeTargetFramework }}
82
      XUnitRunnerVersion: ${{ parameters.XUnitRunnerVersion }}
83
      IncludeDotNetCli: ${{ parameters.IncludeDotNetCli }}
84
      DotNetCliPackageType: ${{ parameters.DotNetCliPackageType }}
85
      DotNetCliVersion: ${{ parameters.DotNetCliVersion }}
86
      WaitForWorkItemCompletion: ${{ parameters.WaitForWorkItemCompletion }}
87
      HelixBaseUri: ${{ parameters.HelixBaseUri }}
88
      Creator: ${{ parameters.Creator }}
89
      SYSTEM_ACCESSTOKEN: $(System.AccessToken)
90
    condition: and(${{ parameters.condition }}, ne(variables['Agent.Os'], 'Windows_NT'))
91
    continueOnError: ${{ parameters.continueOnError }}
92