https://github.com/staffbase/yamllint-action

Lints yaml files and annotates every finding.
https://github.com/staffbase/yamllint-action

actions github-actions yamllint

Last synced: about 1 month ago
JSON representation

Lints yaml files and annotates every finding.

• Host: GitHub
• URL: https://github.com/staffbase/yamllint-action
• Owner: Staffbase
• License: apache-2.0
• Created: 2019-11-18T10:50:28.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-28T12:39:51.000Z (7 months ago)
• Last Synced: 2024-05-29T04:13:52.660Z (7 months ago)
• Topics: actions, github-actions, yamllint
• Language: Go
• Homepage:
• Size: 240 KB
• Stars: 12
• Watchers: 27
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Lint All Your YAML Files

Using this GitHub Action in your workflow to lint all yaml files and then annotates every finding in the changed files view.

![annotation](images/annotation.png)

## Usage

Create a new workflow with the following content:

```yaml

name: YAMLlint

on:

  push:

    branches:

      - '**'

    tags-ignore:

      - '**'

jobs:

  yamllint:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v2

      - name: Lint and Annotate

        uses: staffbase/yamllint-action@v1

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

          ## The target path is processed recursively

          target-path: 

          ## The action name is only necessary if the current action name changed

          action-name: 

```

## Credits

This action is using

- [adrienverge/yamllint](https://github.com/adrienverge/yamllint)

- [sdesbure/docker_yamllint](https://github.com/sdesbure/docker_yamllint)

  

    

      

    

    

      Staffbase GmbH

      
Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: jobs.staffbase.com

      
GitHub | Website | Jobs