A Github Action to reject a PR if it contains malformed YAML files.
YAML syntax errors can be hard to spot by eye, and a malformed file can break a CI/CD pipeline. This action is designed to prevent such errors before the corresponding PR is merged.
This is an example of malformed YAML, which will raise an error if you try to parse it (at least, in Ruby and Python):
desc: Example of a malformed YAML file
key: "\"
Create a file in your repo called .github/workflows/malformed-yaml.yml with the
following contents:
on:
pull_request:
types: [opened, edited, reopened, synchronize]
jobs:
reject-malformed-yaml:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
- uses: actions/checkout@v4.1.2
- name: Detect malformed YAML files
- uses: ministryofjustice/github-actions/malformed-yaml@v18.0.0
env:
GITHUB_TOKEN: $
PR_NUMBER: $
GITHUB_TOKEN and PR_NUMBER are provided automatically. You do
not need to do anything extra to make these available. Just use the
content above, exactly as shown.