Pipeline Components: Ansible-lint

Docker status

Usage

The image is for running Ansible-lint.

Examples

ansible-lint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/ansible-lint:latest
  script:
    - ansible-lint --show-relpath

if your ansible setup is in a subfolder of the git repository, use for example

ansible-lint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/ansible-lint:latest
  script:
    - ansible-lint --show-relpath my-ansible/folder

For using Junit reporting in gitlab:

ansible-lint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/ansible-lint:latest
  artifacts:
    when: always
    reports:
      junit: ansible-lint.xml
  script:
    - ansible-lint -v --show-relpath -f pep8 --nocolor
      | ansible-lint-junit -o ansible-lint.xml

Display Results in the Code Quality section of Gitlab MRs (but also show the results in the console output):

ansible-lint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/ansible-lint:latest
  script:
    - ansible-lint -f codeclimate | python -m json.tool | tee "${CI_PROJECT_DIR}/codeclimate-results.json"
  artifacts:
    name: "$CI_JOB_NAME artifacts from $CI_PROJECT_NAME on $CI_COMMIT_REF_SLUG"
    reports:
      codequality:
        - "${CI_PROJECT_DIR}/codeclimate-results.json"
    paths:
      - "${CI_PROJECT_DIR}/codeclimate-results.json"

Versioning

This project uses Semantic Versioning for its version numbering.

Support

Got questions?

Check the discord channel

You could also open an issue here

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Robbert Müller.

The Build pipeline is large based on Community Hass.io Add-ons by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

This project is licensed under the MIT License by Robbert Müller.