README.md

Yamllint Plugin

A Woodpecker CI plugin for yamllint to lint yaml files. Also usable with Gitlab, Github or locally, see examples for usage.

Features

• preconfigure yamllint parameters
• searches for yaml files recursive
• runnable with local docker daemon

Example

Woodpecker:

steps:
  yamllint:
    image: kokuwaio/yamllint
    depends_on: []
    settings:
      no-warnings: true
      format: json
    when:
      event: pull_request
      path: [.yamllint.yaml, "**/*.y*ml"]

Gitlab:

yamllint:
  stage: lint
  needs: []
  image: kokuwaio/yamllint
  variables:
    PLUGIN_NO_WARNINGS: true
    PLUGIN_FORMAT: json
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: [.yamllint.yaml, "**/*.y*ml"]

CLI:

docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/yamllint --no-warnings --format=json

Settings

Settings Name	Environment	Default	Description
config-file	PLUGIN_CONFIG_FILE	none	Configuration file to use, if none is configured default is used
strict	PLUGIN_STRICT	true	Fail on warnings
no-warnings	PLUGIN_NO_WARNINGS	false	Output only error level problems
format	PLUGIN_FORMAT	colored	Format for parsing output: parsable, standard, colored, github, auto

Alternatives

Image	Comment	amd64	arm64
kokuwaio/yamllint	Woodpecker plugin
pipelinecomponents/yamllint	not a Woodpecker plugin
giantswarm/yamllint	not a Woodpecker plugin
cytopia/yamllint	not a Woodpecker plugin, outdated
sdesbure/yamllint	not a Woodpecker plugin, outdated