|
1 | 1 | parameters: |
2 | | - # Whether the SDL validation job should execute or not |
3 | | - - name: enable |
4 | | - type: boolean |
5 | | - default: false |
6 | | - |
7 | | - # to override values for parameters. |
8 | | - - name: overrideParameters |
9 | | - type: string |
10 | | - default: '' |
11 | | - |
12 | | - # parameters that need user specific values eg: '-SourceToolsList @("abc","def") -ArtifactToolsList @("ghi","jkl")' |
13 | | - - name: additionalParameters |
14 | | - type: string |
15 | | - default: '' |
16 | | - |
| 2 | + enable: 'false' # Whether the SDL validation job should execute or not |
| 3 | + overrideParameters: '' # Optional: to override values for parameters. |
| 4 | + additionalParameters: '' # Optional: parameters that need user specific values eg: '-SourceToolsList @("abc","def") -ArtifactToolsList @("ghi","jkl")' |
17 | 5 | # Optional: if specified, restore and use this version of Guardian instead of the default. |
18 | | - - name: overrideGuardianVersion |
19 | | - type: string |
20 | | - default: '' |
21 | | - |
| 6 | + overrideGuardianVersion: '' |
22 | 7 | # Optional: if true, publish the '.gdn' folder as a pipeline artifact. This can help with in-depth |
23 | 8 | # diagnosis of problems with specific tool configurations. |
24 | | - - name: publishGuardianDirectoryToPipeline |
25 | | - type: boolean |
26 | | - default: false |
27 | | - |
| 9 | + publishGuardianDirectoryToPipeline: false |
28 | 10 | # The script to run to execute all SDL tools. Use this if you want to use a script to define SDL |
29 | 11 | # parameters rather than relying on YAML. It may be better to use a local script, because you can |
30 | 12 | # reproduce results locally without piecing together a command based on the YAML. |
31 | | - - name: executeAllSdlToolsScript |
32 | | - type: string |
33 | | - default: 'eng/common/sdl/execute-all-sdl-tools.ps1' |
34 | | - |
| 13 | + executeAllSdlToolsScript: 'eng/common/sdl/execute-all-sdl-tools.ps1' |
35 | 14 | # There is some sort of bug (has been reported) in Azure DevOps where if this parameter is named |
36 | 15 | # 'continueOnError', the parameter value is not correctly picked up. |
37 | 16 | # This can also be remedied by the caller (post-build.yml) if it does not use a nested parameter |
38 | | - |
39 | | - # optional: determines whether to continue the build if the step errors; |
40 | | - - name: sdlContinueOnError |
41 | | - type: boolean |
42 | | - default: false |
43 | | - |
| 17 | + sdlContinueOnError: false # optional: determines whether to continue the build if the step errors; |
44 | 18 | # optional: determines if build artifacts should be downloaded. |
45 | | - - name: downloadArtifacts |
46 | | - type: boolean |
47 | | - default: true |
48 | | - |
| 19 | + downloadArtifacts: true |
49 | 20 | # optional: determines if this job should search the directory of downloaded artifacts for |
50 | 21 | # 'tar.gz' and 'zip' archive files and extract them before running SDL validation tasks. |
51 | | - - name: extractArchiveArtifacts |
52 | | - type: boolean |
53 | | - default: false |
54 | | - |
55 | | - # optional: dependencies of the job |
56 | | - - name: dependsOn |
57 | | - type: string |
58 | | - default: '' |
59 | | - |
60 | | - # Optional: patterns supplied to DownloadBuildArtifacts |
61 | | - # Usage: |
62 | | - # artifactNames: |
63 | | - # - 'BlobArtifacts' |
64 | | - # - 'Artifacts_Windows_NT_Release' |
65 | | - - name: artifactNames |
66 | | - type: object |
67 | | - default: '' |
68 | | - |
| 22 | + extractArchiveArtifacts: false |
| 23 | + dependsOn: '' # Optional: dependencies of the job |
| 24 | + artifactNames: '' # Optional: patterns supplied to DownloadBuildArtifacts |
| 25 | + # Usage: |
| 26 | + # artifactNames: |
| 27 | + # - 'BlobArtifacts' |
| 28 | + # - 'Artifacts_Windows_NT_Release' |
69 | 29 | # Optional: download a list of pipeline artifacts. 'downloadArtifacts' controls build artifacts, |
70 | 30 | # not pipeline artifacts, so doesn't affect the use of this parameter. |
71 | | - - name: pipelineArtifactNames |
72 | | - type: object |
73 | | - default: [] |
| 31 | + pipelineArtifactNames: [] |
74 | 32 |
|
75 | 33 | jobs: |
76 | 34 | - job: Run_SDL |
|
0 commit comments