From 2fe34b6444502079dc0b84365ce82dbc92de308e Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 13 Apr 2024 14:06:49 +0200
Subject: Adding upstream version 6.17.2.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 src/ansiblelint/rules/run_once.md | 65 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 src/ansiblelint/rules/run_once.md

(limited to 'src/ansiblelint/rules/run_once.md')

diff --git a/src/ansiblelint/rules/run_once.md b/src/ansiblelint/rules/run_once.md
new file mode 100644
index 0000000..024648b
--- /dev/null
+++ b/src/ansiblelint/rules/run_once.md
@@ -0,0 +1,65 @@
+# run-once
+
+This rule warns against the use of `run_once` when the `strategy` is set to
+`free`.
+
+This rule can produce the following messages:
+
+- `run-once[play]`: Play uses `strategy: free`.
+- `run-once[task]`: Using `run_once` may behave differently if the `strategy` is
+  set to `free`.
+
+For more information see the following topics in Ansible documentation:
+
+- [free strategy](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/free_strategy.html#free-strategy)
+- [selecting a strategy](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_strategies.html#selecting-a-strategy)
+- [run_once(playbook keyword) more info](https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html)
+
+!!! warning
+
+    The reason for the existence of this rule is for reminding users that `run_once`
+    is not providing any warranty that the task will run only once.
+    This rule will always trigger regardless of the value configured inside the 'strategy' field. That is because the effective value used at runtime can be different than the value inside the file. For example, ansible command line arguments can alter it.
+
+It is perfectly fine to add `# noqa: run-once[task]` to mark the warning as
+acknowledged and ignored.
+
+## Problematic Code
+
+```yaml
+---
+- name: "Example with run_once"
+  hosts: all
+  strategy: free # <-- avoid use of strategy as free
+  gather_facts: false
+  tasks:
+    - name: Task with run_once
+      ansible.builtin.debug:
+        msg: "Test"
+      run_once: true # <-- avoid use of strategy as free at play level when using run_once at task level
+```
+
+## Correct Code
+
+```yaml
+- name: "Example without run_once"
+  hosts: all
+  gather_facts: false
+  tasks:
+    - name: Task without run_once
+      ansible.builtin.debug:
+        msg: "Test"
+```
+
+```yaml
+- name: "Example of using run_once with strategy other than free"
+  hosts: all
+  strategy: linear
+  # strategy: free # noqa: run-once[play] (if using strategy: free can skip it this way)
+  gather_facts: false
+  tasks: # <-- use noqa to disable rule violations for specific tasks
+    - name: Task with run_once # noqa: run-once[task]
+      ansible.builtin.debug:
+        msg: "Test"
+      run_once: true
+```
-- 
cgit v1.2.3