summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
commit2fe34b6444502079dc0b84365ce82dbc92de308e (patch)
tree8fedcab52bbbc3db6c5aa909a88a7a7b81685018 /README.md
parentInitial commit. (diff)
downloadansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.tar.xz
ansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.zip
Adding upstream version 6.17.2.upstream/6.17.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
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 @@
+[![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-lint.readthedocs.io/rules/)
+[![Discussions](https://img.shields.io/badge/Discussions-gray.svg)](https://github.com/ansible/ansible-lint/discussions)
+[![GitHub Actions CI/CD](https://github.com/ansible/ansible-lint/workflows/gh/badge.svg)](https://github.com/ansible/ansible-lint/actions?query=workflow%3Agh+branch%3Amain+event%3Apush)
+[![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-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