From 07880233d2aa7fedb5890f73c396d20fc758fa6e Mon Sep 17 00:00:00 2001 From: Amine LOUHICHI <32558537+aminelch@users.noreply.github.com> Date: Sun, 20 Apr 2025 13:58:44 +0100 Subject: [PATCH] ansible-lint: add page (#16193) * ansible-lint: add page * Update pages/common/ansible-lint.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update pages/common/ansible-lint.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Wiktor Perskawiec --------- Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> Co-authored-by: Wiktor Perskawiec --- pages/common/ansible-lint.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pages/common/ansible-lint.md diff --git a/pages/common/ansible-lint.md b/pages/common/ansible-lint.md new file mode 100644 index 0000000000..e0c6a7e0bb --- /dev/null +++ b/pages/common/ansible-lint.md @@ -0,0 +1,24 @@ +# ansible-lint + +> Apply rules and follow best practices with your automation content. +> More information: . + +- Lint a specific playbook and a role directory: + +`ansible-lint {{path/to/playbook_file}} {{path/to/role_directory}}` + +- Lint a playbook while excluding specific rules: + +`ansible-lint {{[-x|--exclude-rules]}} {{rule1,rule2,...}} {{path/to/playbook_file}}` + +- Lint a playbook in offline mode and format output as PEP8: + +`ansible-lint {{[-o|--offline]}} {{[-p|--parseable]}} {{path/to/playbook_file}}` + +- Lint a playbook using a custom rules directory: + +`ansible-lint {{[-r|--rules]}} {{path/to/custom_rules_directory}} {{path/to/playbook_file}}` + +- Lint all Ansible content recursively in a given directory: + +`ansible-lint {{path/to/project_directory}}`