kokuwaio/yamllint

By kokuwaio

Updated 3 days ago

A WoodpeckerCI plugin for yamllint to lint yaml files.

Image
Integration & delivery
Developer tools
0

7.1K

kokuwaio/yamllint repository overview

Yamllint WoodpeckerCI Plugin

pulls size dockerfile license prs issues

A WoodpeckerCI 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:
    depends_on: []
    image: kokuwaio/yamllint:v1.38.0
    settings:
      no-warnings: true
      format: json
    when:
      event: pull_request
      path: "**/*.y*ml"

Gitlab: (using script is needed because of https://gitlab.com/gitlab-org/gitlab/-/issues/19717)

yamllint:
  needs: []
  stage: lint
  image:
    name: kokuwaio/yamllint:v1.38.0
    entrypoint: [""]
  script: [/usr/local/bin/entrypoint.sh]
  variables:
    PLUGIN_NO_WARNINGS: true
    PLUGIN_FORMAT: json
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: ["**/*.y*ml"]

CLI:

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

Settings

Settings NameEnvironmentDefaultDescription
config-filePLUGIN_CONFIG_FILEnoneConfiguration file to use, if none is configured default is used
strictPLUGIN_STRICTtrueFail on warnings
no-warningsPLUGIN_NO_WARNINGSfalseOutput only error level problems
formatPLUGIN_FORMATcoloredFormat for parsing output: parsable, standard, colored, github, auto

Alternatives

ImageCommentamd64arm64
kokuwaio/yamllintWoodpecker pluginsizesize
pipelinecomponents/yamllintnot a Woodpecker pluginsizesize
giantswarm/yamllintnot a Woodpecker pluginsizesize
cytopia/yamllintnot a Woodpecker plugin, outdatedsizesize
sdesbure/yamllintnot a Woodpecker plugin, outdatedsizesize

Tag summary

Content type

Image

Digest

sha256:495614a86

Size

38.9 MB

Last updated

3 days ago

docker pull kokuwaio/yamllint:v1.38.0