From cc84b1a545f0cc79f8fc95e5b83075f555998196 Mon Sep 17 00:00:00 2001
From: hadeskun <jad990@gmail.com>
Date: Mon, 9 Dec 2024 11:18:16 +0100
Subject: [PATCH] Add how to set an ansible task as softfailed

Add how to set an ansible task as softfailed.
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index ec61535b..0b243a3e 100644
--- a/README.md
+++ b/README.md
@@ -275,3 +275,19 @@ If the user does not wish to copy the role in the `roles` folder of this reposit
 export ANSIBLE_ROLES_PATH=<the-dir-where-the-role-is-located>
 . . . (run deployment as you would normally do)
 ```
+
+### How to rewrite an ansible task to be softfailed automatically in OSADO
+
+To softfailed an ansible task it is needed to add a msg attribute in the task following this format:
+
+```yaml
+msg: "[OSADO][softfail] [bsc or jsc]#[number] [short description]"
+```
+
+Here a complete example:
+
+```yaml
+- name: Example of debug message
+      ansible.builtin.debug:
+        msg: "[OSADO][softfail] bsc#123456789 Here a generic message with some explanations."
+```