Skip to content

Commit

Permalink
Add step YAML Formatting Guidelines to yaml_formatter.yaml file
Browse files Browse the repository at this point in the history
Signed-off-by: hansinikarunarathne <107214435+hansinikarunarathne@users.noreply.github.com>
  • Loading branch information
hansinikarunarathne committed Jun 29, 2024
1 parent 07dc03e commit e31486c
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion .github/workflows/yaml_formatter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,30 @@ jobs:
run: pip install yamllint

- name: Lint YAML files
run: yamllint .
run: yamllint .

- name: YAML Formatting Guidelines
run: |
echo "### YAML Formatting Guidelines ###
If there is a formatting error in your YAML file, you will see errors like the one below:
'Error: 6:4 [indentation] wrong indentation: expected 2 but found 3'
To fix these errors, refer to the YAML formatting rules at:
https://yamllint.readthedocs.io/en/stable/rules.html#
Search for the keyword inside the brackets [] in the error message. In this example, it's 'indentation'.
Note: Some rules have been customized in the '.yamllint.yaml' file. Below is the content of that file:
extends: default
rules:
document-start:
present: false
document-end:
present: false
indentation:
indent-sequences: false
line-length:
max: 400
"

0 comments on commit e31486c

Please sign in to comment.