Merge pull request #730 from wxtim/fix.728

Make it clearer that set -euo pipefail is _only_ required in
cylc · May 10, 2024 · b6e9f27 · b6e9f27
2 parents 1fcb22c + e2ee3bf
commit b6e9f27
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/src/user-guide/task-implementation/job-scripts.rst b/src/user-guide/task-implementation/job-scripts.rst
@@ -187,6 +187,8 @@ Task messages are validated by:
 .. autoclass:: cylc.flow.unicode_rules.TaskMessageValidator
    :no-index:
 
+.. _job-scripts.aborting-on-error:
+
 Aborting Job Scripts on Error
 -----------------------------
 

diff --git a/src/workflow-design-guide/general-principles.rst b/src/workflow-design-guide/general-principles.rst
@@ -152,6 +152,11 @@ workflow and its tasks, all task scripts should:
    Examples and more details `are available <https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/>`_
    for the above three ``set`` commands.
 
+   Inline scripts (defined in the job-script section of the
+   workflow configuration) do not need to ``set -euo pipefail``:
+   It is already set as part of the
+   :ref:`job script's error handling <job-scripts.aborting-on-error>`.
+
 
 Rose Apps
 ---------