Merge pull request #3127 from mirpedrol/template-customisation-micros…

…oftteams Template: add option to exclude adaptivecard and slackreport from pipeline template
nf-core · Aug 21, 2024 · 7785b4c · 7785b4c
2 parents 43de3bc + f7137ca
commit 7785b4c
Show file tree

Hide file tree

Showing 5 changed files with 292 additions and 259 deletions.
diff --git a/nf_core/pipeline-template/.prettierignore b/nf_core/pipeline-template/.prettierignore
@@ -1,8 +1,12 @@
 {%- if email %}
 email_template.html
 {%- endif %}
+{%- if adaptivecard %}
 adaptivecard.json
+{%- endif %}
+{%- if slackreport %}
 slackreport.json
+{%- endif %}
 .nextflow*
 work/
 data/

diff --git a/nf_core/pipeline-template/main.nf b/nf_core/pipeline-template/main.nf
@@ -102,8 +102,8 @@ workflow {
         {%- endif %}
         params.outdir,
         params.monochrome_logs,
-        params.hook_url,
-        {%- if multiqc %}{{ prefix_nodash|upper }}_{{ short_name|upper }}.out.multiqc_report{% endif %}
+        {% if adaptivecard or slackreport %}params.hook_url,{% endif %}
+        {% if multiqc %}{{ prefix_nodash|upper }}_{{ short_name|upper }}.out.multiqc_report{% endif %}
     )
 }
 

diff --git a/nf_core/pipeline-template/subworkflows/local/utils_nfcore_pipeline_pipeline/main.nf b/nf_core/pipeline-template/subworkflows/local/utils_nfcore_pipeline_pipeline/main.nf
@@ -18,7 +18,9 @@ include { completionEmail           } from '../../nf-core/utils_nfcore_pipeline'
 include { completionSummary         } from '../../nf-core/utils_nfcore_pipeline'
 include { dashedLine                } from '../../nf-core/utils_nfcore_pipeline'
 include { nfCoreLogo                } from '../../nf-core/utils_nfcore_pipeline'
+{%- if adaptivecard or slackreport %}
 include { imNotification            } from '../../nf-core/utils_nfcore_pipeline'
+{%- endif %}
 include { UTILS_NFCORE_PIPELINE     } from '../../nf-core/utils_nfcore_pipeline'
 include { workflowCitation          } from '../../nf-core/utils_nfcore_pipeline'
 
@@ -126,7 +128,7 @@ workflow PIPELINE_COMPLETION {
     {% endif %}
     outdir          //    path: Path to output directory where results will be published
     monochrome_logs // boolean: Disable ANSI colour codes in log output
-    hook_url        //  string: hook URL for notifications
+    {% if adaptivecard or slackreport %}hook_url        //  string: hook URL for notifications{% endif %}
     {% if multiqc %}multiqc_report  //  string: Path to MultiQC report{% endif %}
 
     main:
@@ -149,9 +151,11 @@ workflow PIPELINE_COMPLETION {
 
         completionSummary(monochrome_logs)
 
+        {%- if adaptivecard or slackreport %}
         if (hook_url) {
             imNotification(summary_params, hook_url)
         }
+        {%- endif %}
     }
 
     workflow.onError {

diff --git a/nf_core/pipelines/create/templatefeatures.yml b/nf_core/pipelines/create/templatefeatures.yml
@@ -275,3 +275,28 @@ email:
       - ".prettierignore"
   nfcore_pipelines: False
   custom_pipelines: True
+adaptivecard:
+  skippable_paths:
+    - "assets/adaptivecard.json"
+  short_description: "Support Microsoft Teams notifications"
+  description: "Enable pipeline status update messages through Microsoft Teams"
+  help_text: |
+    This adds an Adaptive Card. A snippets of user interface.
+    This Adaptive Card is used as a template for pipeline update messages and it is compatible with Microsoft Teams.
+  linting:
+    files_unchanged:
+      - ".prettierignore"
+  nfcore_pipelines: False
+  custom_pipelines: True
+slackreport:
+  skippable_paths:
+    - "assets/slackreport.json"
+  short_description: "Support Slack notifications"
+  description: "Enable pipeline status update messages through Slack"
+  help_text: |
+    This adds an JSON template used as a template for pipeline update messages in Slack.
+  linting:
+    files_unchanged:
+      - ".prettierignore"
+  nfcore_pipelines: False
+  custom_pipelines: True
diff --git a/tests/pipelines/__snapshots__/test_create_app.ambr b/tests/pipelines/__snapshots__/test_create_app.ambr