ansible-later/README.md

42 lines
3.1 KiB
Markdown
Raw Normal View History

2018-12-19 10:19:07 +00:00
# ansible-later
2020-09-27 12:56:49 +00:00
Another best practice scanner for Ansible roles and playbooks
2020-09-06 18:22:44 +00:00
2023-08-24 22:07:23 +00:00
[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/ansible-later/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/ansible-later)
2020-09-27 12:56:49 +00:00
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/ansible-later)
2020-09-06 18:44:05 +00:00
[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/ansible-later)
2020-01-27 12:54:31 +00:00
[![Python Version](https://img.shields.io/pypi/pyversions/ansible-later.svg)](https://pypi.org/project/ansible-later/)
[![PyPI Status](https://img.shields.io/pypi/status/ansible-later.svg)](https://pypi.org/project/ansible-later/)
[![PyPI Release](https://img.shields.io/pypi/v/ansible-later.svg)](https://pypi.org/project/ansible-later/)
2020-09-27 12:56:49 +00:00
[![Codecov](https://img.shields.io/codecov/c/github/thegeeklab/ansible-later)](https://codecov.io/gh/thegeeklab/ansible-later)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/ansible-later)](https://github.com/thegeeklab/ansible-later/graphs/contributors)
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/ansible-later)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/ansible-later)](https://github.com/thegeeklab/ansible-later/blob/main/LICENSE)
2018-12-19 10:19:07 +00:00
2021-01-31 21:44:14 +00:00
ansible-later is a best practice scanner and linting tool. In most cases, if you write Ansible roles in a team, it helps to have a coding or best practice guideline in place. This will make Ansible roles more readable for all maintainers and can reduce the troubleshooting time. While ansible-later aims to be a fast and easy to use linting tool for your Ansible resources, it might not be that feature completed as required in some situations. If you need a more in-depth analysis you can take a look at [ansible-lint](https://github.com/ansible-community/ansible-lint).
2018-12-19 10:19:07 +00:00
2021-01-31 12:46:23 +00:00
ansible-later does **not** ensure that your role will work as expected. For deployment tests you can use other tools like [molecule](https://github.com/ansible/molecule).
2020-01-27 12:54:31 +00:00
You can find the full documentation at [https://ansible-later.geekdocs.de](https://ansible-later.geekdocs.de/).
2018-12-19 10:19:07 +00:00
2020-09-06 18:22:44 +00:00
## Community
2020-12-28 17:15:23 +00:00
<!-- prettier-ignore-start -->
2020-09-06 18:44:05 +00:00
<!-- spellchecker-disable -->
2021-01-17 14:10:33 +00:00
2020-09-06 18:22:44 +00:00
- [GitHub Action](https://github.com/patrickjahns/ansible-later-action) by [@patrickjahns](https://github.com/patrickjahns)
2021-01-31 12:46:23 +00:00
<!-- spellchecker-enable -->
<!-- prettier-ignore-end -->
2020-09-06 18:22:44 +00:00
2020-09-27 12:56:49 +00:00
## Contributors
2018-12-19 10:19:07 +00:00
2022-07-15 06:50:07 +00:00
Special thanks to all [contributors](https://github.com/thegeeklab/ansible-later/graphs/contributors). If you would like to contribute,
please see the [instructions](https://github.com/thegeeklab/ansible-later/blob/main/CONTRIBUTING.md).
2018-12-19 10:19:07 +00:00
2020-09-27 13:25:20 +00:00
ansible-later is a fork of Will Thames [ansible-review](https://github.com/willthames/ansible-review). Thanks for your work on ansible-review and ansible-lint.
2020-09-27 12:56:49 +00:00
## License
2018-12-19 10:19:07 +00:00
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/ansible-later/blob/main/LICENSE) file for details.