/yamllint-pr-annotator

Annotate pull requests with yamllint errors detected during CI

MIT LicenseMIT

Yamllint PR Annotator

demo

Usage

Annotate pull requests with yamllint errors detected during CI.

This is designed to work with the "parsable" output format of yamllint.

Note: This doesn't install or run yamllint, it just sets up the PR annotations.

Example workflow

name: My Workflow
on: [push, pull_request]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: Set up Python 3.8
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"
        
      - name: Install yamllint
        run: |
          pip install yamllint

      - name: Add yamllint annotator
        uses: pr-annotators/yamllint-pr-annotator@v1.0.0

      - name: Run yamllint
        run: |
          yamllint -f parsable src/