You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
This action allows you to run ansible-lint on your codebase without having to
install it yourself.
# .github/workflows/ansible-lint.ymlname: ansible-linton:
pull_request:
branches: ["main", "stable", "release/v*"]jobs:
build:
name: Ansible Lint # Naming the build is important to use it as a status checkruns-on: ubuntu-24.04steps:
- uses: actions/checkout@v4
- name: Run ansible-lintuses: ansible/ansible-lint@main # or vX.X.X version# optional (see below):with:
args: ""gh_action_ref: "<version - e.g. `v25.5.0`>"# Not recommended for non-composite action usesetup_python: "true"python_version: "3.14"working_directory: ""requirements_file: ""
By default, the workflow uses ansible-lint installed from main. For production or stable workflows, it is recommended to specify a particular release tag (in format v.X.X.X).
All the arguments are optional:
args: Arguments to be passed to ansible-lint command.
gh_action_ref: The git branch, tag, or commit to use for ansible-lint.
Not recommended for standard use - only use with composite actions where
GH_ACTION_REF is set to the parent action version.
requirements_file: Path to the requirements.yml file to install role and
collection dependencies.
setup_python: If python should be installed. Default is true.
python_version: The version of python to install. Default is 3.14.
working_directory: The directory where to run ansible-lint from. Default is
github.workspace. Needed if you want to lint only a subset of
your repository.
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.
About
ansible-lint checks playbooks for practices and behavior that could potentially be improved and can fix some of the most common ones for you