Validate YAML file using Powershell/CMD in Azure pipeline

Question

I need to validate the YAML file in azure pipeline either via PowerShell or CMD, if the YAML file is invalid then it should fail the task.

Can you please suggest some inputs on how to achieve it.

Do you mean to `azure-pipelines.yml` file or another `.yml` file? — Shayki Abramczyk, Nov 03 '20 at 12:45

score 1 · Answer 1 · answered Nov 02 '20 at 17:29

1

You can use powershell-yaml module to validate YAML file as below:

    steps:
    - pwsh: Install-Module powershell-yaml -Force
    - pwsh: |
        $content = Get-Content -Path stackoverflow\80-yaml\test.yaml -Raw
        $correct = true
        try {
          $obj = ConvertFrom-Yaml $content
          Write-Host $obj
        }
        catch {
            Write-Host "An error occurred:"
            
            $correct = false
        }
        

        
        Write-Host $correct

But please remember about setting $ErrorActionPreference

answered Nov 02 '20 at 17:29

Krzysztof Madej

32,704
10
78
107

Thanks a lot, this works but is it according to OpenAPI Specification standard ? – Raghu Hoskote Nov 06 '20 at 02:19
Difficult to say as this is implementation detail of powershell-yaml module. Can you consider upvoing my anser if it was useful for you? – Krzysztof Madej Nov 06 '20 at 02:21

score 1 · Accepted Answer · answered Nov 03 '20 at 14:42

Just like Shayki Abramczyk commented not sure if you want to azure-pipelines.yml file or another .yml file

For `azure-pipelines.yml`

There is a server-side API for this :

POST to dev.azure.com/<org>/<project>/_apis/pipelines/<pipelineId>/runs?api-version=5.1-preview with a JSON body like this:

{
  "PreviewRun": true,
  "YamlOverride": "
# your new YAML here, optionally
"
}

The response will contain the rendered YAML. More details you could refer link here: Expose YAML validation features as standalone tool

For other `.yml` file

You could either use a script in powershell task or some 3rd-party extension Files Validator to handle this.

Yes, Files Validator, works like a charm, but we are not suppose to use due to some restrictions :( — Raghu Hoskote, Nov 06 '20 at 02:21

Validate YAML file using Powershell/CMD in Azure pipeline

2 Answers2

For azure-pipelines.yml

For other .yml file

For `azure-pipelines.yml`

For other `.yml` file