This action executes yamllint (https://github.com/adrienverge/yamllint) against files or folder
Simple as:
- uses: ibiqlik/action-yamllint@v3config_file- Path to custom configurationconfig_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.yamlfile1.yaml file2.yamlkustomize/**/*.yaml mychart/*values.yaml
format- Format for parsing output[parsable,standard,colored,github,auto] (default: parsable)strict- Return non-zero exit code on warnings as well as errors[true,false] (default: false)no_warnings- Output only error level problems[true,false] (default: false)
Note: If .yamllint configuration file exists in your root folder, yamllint automatically uses it.
logfile - Path to yamllint log file
${{ steps.<step>.outputs.logfile }}
Note: Each yamllint run (for example if you define multiple yamllint steps) has its own log
---
name: Yaml Lint
on: [push] # yamllint disable-line rule:truthy
jobs:
lintAllTheThings:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: yaml-lint
uses: ibiqlik/action-yamllint@v3
with:
file_or_dir: myfolder/*values*.yaml
config_file: .yamllint.ymlOr just simply lint all yaml files in the repository:
---
name: Yaml Lint
on: [push] # yamllint disable-line rule:truthy
jobs:
lintAllTheThings:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: yaml-lint
uses: ibiqlik/action-yamllint@v3Config data examples:
# Single line
config_data: "{extends: default, rules: {new-line-at-end-of-file: disable}}"# Multi line
config_data: |
extends: default
rules:
new-line-at-end-of-file:
level: warning
trailing-spaces:
level: warningUse output to save/upload the log in artifact. Note, you must have id in the step running the yamllint action.
---
name: Yaml Lint
on: [push] # yamllint disable-line rule:truthy
jobs:
lintAllTheThings:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- id: yaml-lint
uses: ibiqlik/action-yamllint@v3
- run: echo ${{ steps.yaml-lint.outputs.logfile }}
- uses: actions/upload-artifact@v2
if: always()
with:
name: yamllint-logfile
path: ${{ steps.yaml-lint.outputs.logfile }}
YAML Lint is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)YAML Lint is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.