Yamllint Composite Action

A GitHub composite action to run yamllint, a linter for YAML files.

Usage

A simplified example on how this action can be utilized, could look like this.

on: [pull_request]

jobs:
  lint_yaml:
    runs-on: ubuntu-latest
    name: Lint YAML files
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Lint YAML
        id: yamllint
        uses: actungs/yamllint-composite-action@v1

      - name: Use linter output
        if: always()
        run: echo ${{ steps.yamllint.outputs.lint_output }}

See this action releases or tags for all available versions.

Inputs

This action accepts the following inputs.

Name	Description	Required	Default
files_or_dirs	A space separated list of files or directories to be linted	no	current working directory
config_file	Path to a custom configuration file	no	""
config_data	Custom configuration (as YAML source)	no	""
strict	Return non-zero exit code on warnings as well as errors	no	false
no_warnings	Output only error level problems	no	false
format	The format for parsing output. Available options: parsable, standard, colored, github, auto	no	auto

Outputs

This action returns the following outputs.

Name	Description
lint_output	Result from yamllint check

Note: When using the output in a follow up step(s), one of these conditions if: always() or if: success() || failure() should be added, to prevent the step to be skipped when errors are found.

License

Distributed under the MIT License. See LICENSE for more information.