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.

# .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-24.04
    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 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.

Metadata

Release files for ansible-lint 24.12.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-lint 24.12.2
File	Size	Uploaded
ansible_lint-24.12.2.tar.gz	548.0 kB	Dec 12, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for ansible-lint 24.12.2
File	Interpreter	ABI	Platform	Reset
ansible_lint-24.12.2-py3-none-any.whl 310.7 kB Dec 12, 2024	Python 3	none	any	Details

Total release size: 858.7 kB

Release files / ansible_lint-24.12.2.tar.gz

Download URL	ansible_lint-24.12.2.tar.gz
Size	548.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`f636309c4e7f724fc1a544df529c4c2354f54cf35ede11d750366afb1158a464`
BLAKE2b-256 checksum How to use checksums	`7d52131fdc2305536a6482265dc2de01279cbb138716e86ead5c3d8357430695`
Upload date	Dec 12, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.0.1 CPython/3.12.8`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ansible/ansible-lint
Publishing commit: github.com/ansible/ansible-lint/tree/4ce8e497d462cf73b4d4fac1e97b4ace4f317dcc

Workflow

Publishing configuration: github.com/ansible/ansible-lint/blob/4ce8e497d462cf73b4d4fac1e97b4ace4f317dcc/.github/workflows/release.yml
Publishing logs: github.com/ansible/ansible-lint/actions/runs/12297809973/attempts/1

Artifact

Subject: ansible_lint-24.12.2.tar.gz
SHA-256 checksum: f636309c4e7f724fc1a544df529c4c2354f54cf35ede11d750366afb1158a464 Verifying attestations

Release files / ansible_lint-24.12.2-py3-none-any.whl

Download URL	ansible_lint-24.12.2-py3-none-any.whl
Size	310.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ce7a783ce4f053a965e31f308cdb57554259052efea04b8491c9704f11095e54`
BLAKE2b-256 checksum How to use checksums	`0b307b4c1038fb491438243a99bd3d65b2c2dd450b821617107fa5e3d0ad108f`
Upload date	Dec 12, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.0.1 CPython/3.12.8`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ansible/ansible-lint
Publishing commit: github.com/ansible/ansible-lint/tree/4ce8e497d462cf73b4d4fac1e97b4ace4f317dcc

Workflow

Publishing configuration: github.com/ansible/ansible-lint/blob/4ce8e497d462cf73b4d4fac1e97b4ace4f317dcc/.github/workflows/release.yml
Publishing logs: github.com/ansible/ansible-lint/actions/runs/12297809973/attempts/1

Artifact

Subject: ansible_lint-24.12.2-py3-none-any.whl
SHA-256 checksum: ce7a783ce4f053a965e31f308cdb57554259052efea04b8491c9704f11095e54 Verifying attestations