actions/yamllint
actions/yamllint
3
0
Fork 0
mirror of https://github.com/ibiqlik/action-yamllint.git synced 2024-11-23 10:09:33 +01:00
Code Issues Projects Activity Pipelines
yamllint/README.md
Petr Ruzicka cf0212bc66 Use the current directory as default path for yamllint 
Use the current directory as default path for yamllint.
It's a handy default option which allows yamllint to check all yaml
files in repository by default (which is usually the use case).
2020-01-27 11:11:33 +01:00

1.2 KiB
Raw Blame History

GitHub YAMLlint

This action executes yamllint (https://github.com/adrienverge/yamllint) against file(s) or folder

Usage

Optional parameters

  • config_file - Path to custom configuration
  • config_data - Custom configuration (as YAML source)
  • file_or_dir - Enter file/folder (space separated), wildcards accepted. Examples:
    • . - run against all yaml files in a directory recursively (default)
    • file1.yaml
    • file1.yaml file2.yaml
    • kustomize/**/*.yaml mychart/*values.yaml
  • format - Format for parsing output [parsable,standard,colored,auto]
  • strict - Return non-zero exit code on warnings as well as errors [true,false]

Example usage in workflow

name: Yaml Lint
on: [push]
jobs:
  lintAllTheThings:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: yaml-lint
      uses: ibiqlik/action-yamllint@master
      with:
        file_or_dir: myfolder/*values*.yaml
        config_file: .yamllint.yml

Or just simply check all yaml files in the repository:

name: Yaml Lint
on: [push]
jobs:
  lintAllTheThings:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: yaml-lint
      uses: ibiqlik/action-yamllint@master