| Name | ansible-lint JSON |
| Version |
24.12.2
JSON |
| download |
| home_page | None |
| Summary | Checks playbooks for practices and behavior that could potentially be improved |
| upload_time | 2024-12-12 13:53:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | GPLv3+ |
| keywords |
ansible
lint
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/ansible-lint)
[](https://ansible.readthedocs.io/projects/lint/rules/)
[](https://forum.ansible.com/tag/ansible-lint)
[](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-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](https://ansible.readthedocs.io/projects/lint/contributing/#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](https://docs.ansible.com/ansible/devel/community/communication.html).
# Contributing
Please read [Contribution guidelines] if you wish to contribute.
# Code of Conduct
Please see the
[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
# 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/7d/52/131fdc2305536a6482265dc2de01279cbb138716e86ead5c3d8357430695/ansible_lint-24.12.2.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/ansible-lint)\n[](https://ansible.readthedocs.io/projects/lint/rules/)\n[](https://forum.ansible.com/tag/ansible-lint)\n[](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-24.04\n steps:\n - uses: actions/checkout@v4\n - name: Run ansible-lint\n uses: ansible/ansible-lint@main\n # optional (see below):\n with:\n args: \"\"\n setup_python: \"true\"\n working_directory: \"\"\n requirements_file: \"\"\n```\n\nAll the arguments are optional and most users should not need them:\n\n- `args`: Arguments to be passed to ansible-lint command.\n- `setup_python`: If python should be installed. Default is `true`.\n- `working_directory`: The directory where to run ansible-lint from. Default is\n `github.workspace`. That might be needed if you want to lint only a subset of\n your repository.\n- `requirements_file`: Path to the requirements.yml file to install role and\n collection dependencies.\n\nFor more details, see [ansible-lint-action].\n\n# Communication\n\nRefer to the\n[Talk to us](https://ansible.readthedocs.io/projects/lint/contributing/#talk-to-us)\nsection of the Contributing guide to find out how to get in touch with us.\n\nYou can also find more information in the\n[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).\n\n# Contributing\n\nPlease read [Contribution guidelines] if you wish to contribute.\n\n# Code of Conduct\n\nPlease see the\n[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).\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 [Ansible]\nby [Red Hat] project.\n\n[ansible]: https://ansible.com\n[contribution guidelines]:\n 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.12.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": "0b307b4c1038fb491438243a99bd3d65b2c2dd450b821617107fa5e3d0ad108f",
"md5": "f32abba4cde725f315a1ceb0aee00547",
"sha256": "ce7a783ce4f053a965e31f308cdb57554259052efea04b8491c9704f11095e54"
},
"downloads": -1,
"filename": "ansible_lint-24.12.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f32abba4cde725f315a1ceb0aee00547",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 310681,
"upload_time": "2024-12-12T13:53:01",
"upload_time_iso_8601": "2024-12-12T13:53:01.352821Z",
"url": "https://files.pythonhosted.org/packages/0b/30/7b4c1038fb491438243a99bd3d65b2c2dd450b821617107fa5e3d0ad108f/ansible_lint-24.12.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d52131fdc2305536a6482265dc2de01279cbb138716e86ead5c3d8357430695",
"md5": "4dfa26eb979e18ae613019ea1a1d32f3",
"sha256": "f636309c4e7f724fc1a544df529c4c2354f54cf35ede11d750366afb1158a464"
},
"downloads": -1,
"filename": "ansible_lint-24.12.2.tar.gz",
"has_sig": false,
"md5_digest": "4dfa26eb979e18ae613019ea1a1d32f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 548046,
"upload_time": "2024-12-12T13:53:04",
"upload_time_iso_8601": "2024-12-12T13:53:04.169927Z",
"url": "https://files.pythonhosted.org/packages/7d/52/131fdc2305536a6482265dc2de01279cbb138716e86ead5c3d8357430695/ansible_lint-24.12.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 13:53:04",
"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"
}
