gitlab-ci/pages/projects/gitlab-ci/yaml_lint.md

title, description, date, template, about

title	description	date	template	about
YAML Linting	How to use No Fuss Computings gitlab-ci job for YAML Linting	2021-08-11	manual.html	https://gitlab.com/nofusscomputing/projects/gitlab-ci

This job does yaml linting when any commit is pushed to any branch.

This job provides the following badge:

• None

Dependencies

• None

your .gitlab-ci.yml changes

To use this job add the following to your .gitlab-ci.yml file

stages:
    - validation

include:
    - remote: https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/raw/master/yaml_lint/.gitlab-ci.yml

Yaml Lint (python 3.6):
    variables:
        YAML_LINT_PATH: "."
        YAML_LINT_EXTRA_ARGS: "{ extends: $ROOT_DIR/yaml_lint/.yamllint.yaml, ignore: [gitlab-ci/*] }"
    extends:
        - .yaml_linter_defaults
    image: python:3.6-slim

You can use any python version you wish.

CI/CD Variables required

var name	Description
YAML_LINT_PATH	The path you wish the linter to search for yaml files, defaults to .
YAML_LINT_EXTRA_ARGS	configuration in yaml format., defaults to { extends: $ROOT_DIR/yaml_lint/.yamllint.yaml, ignore: [gitlab-ci/*] } for further info see the YAML Lint docs

Job Workflow

• This job will lint any yaml file in the specified directory using the specified rules.

Artifacts

• $CI_PROJECT_DIR/artifacts - Root artifact directory
• $CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/$PYTHON_VERSION-yaml-lint.junit.xml - JUnit Test report
• $CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$PYTHON_VERSION-yaml-lint.log - Linter log

License

To view the license for this folder and any sub-folders, refer here