From 572f2116226bca4686c3540be9bd8b81bdded54e Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Wed, 10 Jul 2024 15:38:17 +0200 Subject: [PATCH] Link to other docs on the failOnIgnore option (#5122) [ci skip] Signed-off-by: James A. Fellows Yates Co-authored-by: Adam Talbot <12817534+adamrtalbot@users.noreply.github.com> --- docs/metadata.md | 2 ++ docs/process.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/metadata.md b/docs/metadata.md index 4197f7f1ec..2294e3cbe9 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -63,6 +63,8 @@ The following table lists the properties that can be accessed on the `workflow` ::: : Whether the `workflow.failOnIgnore` config option was enabled. +: See {ref}`process-error-strategy` for use-cases of this option. + `workflow.fusion.enabled` : Whether Fusion is enabled. diff --git a/docs/process.md b/docs/process.md index 24c83b407a..0bab07218b 100644 --- a/docs/process.md +++ b/docs/process.md @@ -1691,6 +1691,8 @@ To illustrate the differences between error strategies, consider the following e - **errorStrategy `finish`**: Nextflow will allow any other existing tasks to conclude (but not submit any more) and report an error. - **errorStrategy `ignore`**: Nextflow will continue submitting tasks for the remaining 95 samples, complete the workflow, and report a successful pipeline completion. - **errorStrategy `ignore` and `workflow.failOnIgnore` set to `true` in configuration**: The same behavior as setting the errorStrategy alone, except the pipeline will return an exit status of -1 and report an error. + +See {ref}`metadata-workflow` for more information on `workflow.failOnIgnore`. ::: The `retry` error strategy allows you to re-submit for execution a process returning an error condition. For example: