summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/avoid_implicit.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/ansiblelint/rules/avoid_implicit.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/src/ansiblelint/rules/avoid_implicit.md b/src/ansiblelint/rules/avoid_implicit.md
new file mode 100644
index 0000000..4c3d781
--- /dev/null
+++ b/src/ansiblelint/rules/avoid_implicit.md
@@ -0,0 +1,37 @@
+# avoid-implicit
+
+This rule identifies the use of dangerous implicit behaviors, often also
+undocumented.
+
+This rule will produce the following type of error messages:
+
+- `avoid-implicit[copy-content]` is not a string as [copy](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/copy_module.html#synopsis)
+ modules also accept these, but without documenting them.
+
+## Problematic Code
+
+```yaml
+---
+- name: Example playbook
+ hosts: localhost
+ tasks:
+ - name: Write file content
+ ansible.builtin.copy:
+ content: { "foo": "bar" } # <-- should use explicit jinja template
+ dest: /tmp/foo.txt
+```
+
+## Correct Code
+
+```yaml
+---
+- name: Example playbook
+ hosts: localhost
+ tasks:
+ - name: Write file content
+ vars:
+ content: { "foo": "bar" }
+ ansible.builtin.copy:
+ content: "{{ content | to_json }}" # explicit better than implicit!
+ dest: /tmp/foo.txt
+```