https://github.com/pr-annotators/yamllint-pr-annotator

Annotate pull requests with yamllint errors detected during CI
https://github.com/pr-annotators/yamllint-pr-annotator

annotations code-review github-actions pull-requests yaml yamllint

Last synced: 5 days ago
JSON representation

Annotate pull requests with yamllint errors detected during CI

• Host: GitHub
• URL: https://github.com/pr-annotators/yamllint-pr-annotator
• Owner: pr-annotators
• License: mit
• Created: 2022-03-31T16:33:46.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-01T10:37:09.000Z (almost 3 years ago)
• Last Synced: 2024-11-27T20:33:04.634Z (2 months ago)
• Topics: annotations, code-review, github-actions, pull-requests, yaml, yamllint
• Homepage:
• Size: 652 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yamllint PR Annotator

![demo](images/demo.png)

## 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

```yaml

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/[email protected]

      - name: Run yamllint

        run: |

          yamllint -f parsable src/

```