ansible-lint


Nameansible-lint JSON
Version 24.2.2 PyPI version JSON
download
home_pageNone
SummaryChecks playbooks for practices and behavior that could potentially be improved
upload_time2024-04-09 15:26:36
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseGPLv3+
keywords ansible lint
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![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://github.com/ansible/ansible-lint/discussions)
[![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 # or version tag instead of 'main'
```

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

# Contributing

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

# 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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ansible-lint",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Ansible by Red Hat <info@ansible.com>",
    "keywords": "ansible, lint",
    "author": null,
    "author_email": "Will Thames <will@thames.id.au>",
    "download_url": "https://files.pythonhosted.org/packages/cd/22/1150dbdab0e05230535c517efed0bdcdea334b7b36f5e3ef9477eeea8612/ansible-lint-24.2.2.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://img.shields.io/pypi/v/ansible-lint.svg)](https://pypi.org/project/ansible-lint)\n[![Ansible-lint rules explanation](https://img.shields.io/badge/Ansible--lint-rules-blue.svg)](https://ansible.readthedocs.io/projects/lint/rules/)\n[![Discussions](https://img.shields.io/badge/Discussions-gray.svg)](https://github.com/ansible/ansible-lint/discussions)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n\n# Ansible-lint\n\n`ansible-lint` checks playbooks for practices and behavior that could\npotentially be improved. As a community-backed project ansible-lint supports\nonly the last two major versions of Ansible.\n\n[Visit the Ansible Lint docs site](https://ansible.readthedocs.io/projects/lint/)\n\n# Using ansible-lint as a GitHub Action\n\nThis action allows you to run `ansible-lint` on your codebase without having to\ninstall it yourself.\n\n```yaml\n# .github/workflows/ansible-lint.yml\nname: ansible-lint\non:\n  pull_request:\n    branches: [\"main\", \"stable\", \"release/v*\"]\njobs:\n  build:\n    name: Ansible Lint # Naming the build is important to use it as a status check\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - name: Run ansible-lint\n        uses: ansible/ansible-lint@main # or version tag instead of 'main'\n```\n\nFor more details, see [ansible-lint-action].\n\n# Contributing\n\nPlease read [Contribution guidelines] if you wish to contribute.\n\n# Licensing\n\nThe ansible-lint project is distributed as [GPLv3] due to use of [GPLv3] runtime\ndependencies, like `ansible` and `yamllint`.\n\nFor historical reasons, its own code-base remains licensed under a more liberal\n[MIT] license and any contributions made are accepted as being made under\noriginal [MIT] license.\n\n# Authors\n\nansible-lint was created by [Will Thames] and is now maintained as part of the\n[Ansible] by [Red Hat] project.\n\n[ansible]: https://ansible.com\n[contribution guidelines]: https://ansible.readthedocs.io/projects/lint/contributing\n[gplv3]: https://github.com/ansible/ansible-lint/blob/main/COPYING\n[mit]:\n  https://github.com/ansible/ansible-lint/blob/main/docs/licenses/LICENSE.mit.txt\n[red hat]: https://redhat.com\n[will thames]: https://github.com/willthames\n[ansible-lint-action]:\n  https://ansible.readthedocs.io/projects/lint/installing/#installing-from-source-code\n",
    "bugtrack_url": null,
    "license": "GPLv3+",
    "summary": "Checks playbooks for practices and behavior that could potentially be improved",
    "version": "24.2.2",
    "project_urls": {
        "changelog": "https://github.com/ansible/ansible-lint/releases",
        "documentation": "https://ansible.readthedocs.io/projects/lint/",
        "homepage": "https://github.com/ansible/ansible-lint",
        "repository": "https://github.com/ansible/ansible-lint"
    },
    "split_keywords": [
        "ansible",
        " lint"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "41d3592d0a3bf75bc59750846bdc95a2c2b3f237f119e6943f8312a917df7be5",
                "md5": "818fe5ac9abbdbce6714dafcc0731c51",
                "sha256": "21b66fc4e8c5ea4401dcc46523ae96076ff16d1c96437dd77480698500cc82e6"
            },
            "downloads": -1,
            "filename": "ansible_lint-24.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "818fe5ac9abbdbce6714dafcc0731c51",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 298763,
            "upload_time": "2024-04-09T15:26:32",
            "upload_time_iso_8601": "2024-04-09T15:26:32.204500Z",
            "url": "https://files.pythonhosted.org/packages/41/d3/592d0a3bf75bc59750846bdc95a2c2b3f237f119e6943f8312a917df7be5/ansible_lint-24.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd221150dbdab0e05230535c517efed0bdcdea334b7b36f5e3ef9477eeea8612",
                "md5": "6995860a13b16138a1a5b71fa9f28bdf",
                "sha256": "e849476e1502e37e5a46c2628c993260ce464bdf79751963735dccb68305197e"
            },
            "downloads": -1,
            "filename": "ansible-lint-24.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6995860a13b16138a1a5b71fa9f28bdf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 515822,
            "upload_time": "2024-04-09T15:26:36",
            "upload_time_iso_8601": "2024-04-09T15:26:36.184809Z",
            "url": "https://files.pythonhosted.org/packages/cd/22/1150dbdab0e05230535c517efed0bdcdea334b7b36f5e3ef9477eeea8612/ansible-lint-24.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-09 15:26:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ansible",
    "github_project": "ansible-lint",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ansible-lint"
}
        
Elapsed time: 0.31131s