
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
Using ansible-lint as a GitHub Action
This action allows you to run ansible-lint
on your codebase without having to
install it yourself.
name: ansible-lint
on:
pull_request:
branches: ["main", "stable", "release/v*"]
jobs:
build:
name: Ansible Lint
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Run ansible-lint
uses: ansible/ansible-lint@main
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
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.
Contributing
Please read Contribution guidelines if you wish to contribute.
Code of Conduct
Please see the
Ansible Community Code of Conduct.
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.