https://github.com/ansible/ansible-lint

ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you
https://github.com/ansible/ansible-lint

ansible ansible-dev-tools ansible-lint dot-config hacktoberfest pep-621 pre-commit-hook

Last synced: 6 days ago
JSON representation

ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you

• Host: GitHub
• URL: https://github.com/ansible/ansible-lint
• Owner: ansible
• License: gpl-3.0
• Created: 2013-08-14T11:08:00.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T20:50:38.000Z (5 months ago)
• Last Synced: 2024-06-20T05:47:54.467Z (5 months ago)
• Topics: ansible, ansible-dev-tools, ansible-lint, dot-config, hacktoberfest, pep-621, pre-commit-hook
• Language: Python
• Homepage: https://ansible.readthedocs.io/projects/lint/
• Size: 8.69 MB
• Stars: 3,379
• Watchers: 61
• Forks: 640
• Open Issues: 68
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: COPYING
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-repositories - ansible/ansible-lint - ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you (Python)
• awesome-ansible - Ansible Lint - Checks Playbooks for best practices and behavior that could potentially be improved. (Tools)
• awesome-ansible - Ansible Lint - Checks playbooks for practices and behaviour that could potentially be improved. (Tools)
• awesome-linters - ansible-lint - Checks playbooks for (Linters / Ansible)

README

        
[![PyPI version](https://img.shields.io/pypi/v/ansible-lint.svg)](https://pypi.org/project/ansible-lint)

[![Ansible-lint rules explanation](https://img.shields.io/badge/Ansible--lint-rules-blue.svg)](https://ansible.readthedocs.io/projects/lint/rules/)

[![Discussions](https://img.shields.io/badge/Discussions-gray.svg)](https://forum.ansible.com/tag/ansible-lint)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

# Ansible-lint

`ansible-lint` checks playbooks for practices and behavior that could

potentially be improved. As a community-backed project ansible-lint supports

only the last two major versions of Ansible.

[Visit the Ansible Lint docs site](https://ansible.readthedocs.io/projects/lint/)

# Using ansible-lint as a GitHub Action

This action allows you to run `ansible-lint` on your codebase without having to

install it yourself.

```yaml

# .github/workflows/ansible-lint.yml

name: ansible-lint

on:

  pull_request:

    branches: ["main", "stable", "release/v*"]

jobs:

  build:

    name: Ansible Lint # Naming the build is important to use it as a status check

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - name: Run ansible-lint

        uses: ansible/ansible-lint@main

        # optional (see below):

        with:

          args: ""

          setup_python: "true"

          working_directory: ""

          requirements_file: ""

```

All the arguments are optional and most users should not need them:

- `args`: Arguments to be passed to ansible-lint command.

- `setup_python`: If python should be installed. Default is `true`.

- `working_directory`: The directory where to run ansible-lint from. Default is

  `github.workspace`. That might be needed if you want to lint only a subset of

  your repository.

- `requirements_file`: Path to the requirements.yml file to install role and

  collection dependencies.

For more details, see [ansible-lint-action].

# Communication

Refer to the

[Talk to us](https://ansible.readthedocs.io/projects/lint/contributing/#talk-to-us)

section of the Contributing guide to find out how to get in touch with us.

You can also find more information in the

[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).

# Contributing

Please read [Contribution guidelines] if you wish to contribute.

# Code of Conduct

Please see the

[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).

# Licensing

The ansible-lint project is distributed as [GPLv3] due to use of [GPLv3] runtime

dependencies, like `ansible` and `yamllint`.

For historical reasons, its own code-base remains licensed under a more liberal

[MIT] license and any contributions made are accepted as being made under

original [MIT] license.

# Authors

ansible-lint was created by [Will Thames] and is now maintained as part of the [Ansible]

by [Red Hat] project.

[ansible]: https://ansible.com

[contribution guidelines]:

  https://ansible.readthedocs.io/projects/lint/contributing

[gplv3]: https://github.com/ansible/ansible-lint/blob/main/COPYING

[mit]:

  https://github.com/ansible/ansible-lint/blob/main/docs/licenses/LICENSE.mit.txt

[red hat]: https://redhat.com

[will thames]: https://github.com/willthames

[ansible-lint-action]:

  https://ansible.readthedocs.io/projects/lint/installing/#installing-from-source-code