Skip to main content

Checks playbooks for practices and behavior that could potentially be improved

Project description

PyPI version Ansible-lint rules explanation Discussions 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

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible_lint-24.9.1.tar.gz (536.2 kB view details)

Uploaded Source

Built Distribution

ansible_lint-24.9.1-py3-none-any.whl (307.9 kB view details)

Uploaded Python 3

File details

Details for the file ansible_lint-24.9.1.tar.gz.

File metadata

  • Download URL: ansible_lint-24.9.1.tar.gz
  • Upload date:
  • Size: 536.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for ansible_lint-24.9.1.tar.gz
Algorithm Hash digest
SHA256 5fff4f40d47890b5d91d011726b3935712efe08ac3d8a3b261dafb67ce4a0ce3
MD5 c0fa729f4a25b674aa388708197742b5
BLAKE2b-256 5dfc4f041ed2e80600e9e184499308bab1369290636411c56c0f5afad592d109

See more details on using hashes here.

File details

Details for the file ansible_lint-24.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ansible_lint-24.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc5d3722874667a00710b5fae13f4f5255176b614026e3f6f37574a7cd1e54df
MD5 14b7f3b4d614c63ca5b27c728eac45b5
BLAKE2b-256 708ef17c08fe5f5a101e89d10f49a85d39593518d3253c3d29490be5043b0285

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page