diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..02023f6 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +[](https://pypi.org/project/ansible-lint) +[](https://ansible-lint.readthedocs.io/rules/) +[](https://github.com/ansible/ansible-lint/discussions) +[](https://github.com/ansible/ansible-lint/actions?query=workflow%3Agh+branch%3Amain+event%3Apush) +[](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-lint.readthedocs.io/) + +# 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: ["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: + - name: Run ansible-lint + uses: ansible/ansible-lint-action@v6 +``` + +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-lint.readthedocs.io/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-lint.readthedocs.io/installing/#installing-from-source-code |