Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

check your yaml

Rob Sewell edited this page Mar 17, 2021 · 1 revision

Check your YAML

Before creating your PR. Please check your YAML is correctly formed. The best way to do this is to use the YAML extension in VS Code or Azure Data Studio and look for the problems. This will save you many hours of frustration with spaces ;-)

With the extension installed in Azure Data Studio and the YAML file open. Take a look in the terminal panel at the bottom. If you have it closed pressing CTRL + ' will open it or CTRL + SHIFT + P and search for Terminal Focus and select Terminal: Focus on Terminal View

image

In the panel, you will see a Problems Tab

image

If it looks like this and you have the YAML file open then the YAML is formatted correctly.

However, if there are issues you will see a number next to the Problems tab

image

You will also notice in the file that there are little red squiggles near the issue. In YAML files these are sometimes difficult to notice

Clicking on the Problems tab will show the "problem" and the location. Clicking on it will move the focus to the place in the file where the issue is.

image

You will need to fix the file so that the problems go away. It will automatically refresh after a brief period of time. With YAML the problem is often to do with spaces. In the example above, there is an extra space before call for speakers.

Next - Create a Pull Request to the Data Saturdays GitHub repository