add docs about skipping tests

nf-core · Jan 9, 2025 · 4a1c602 · 4a1c602
1 parent 6e6d3a4
commit 4a1c602
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/sites/docs/src/content/docs/guidelines/components/modules.md b/sites/docs/src/content/docs/guidelines/components/modules.md
@@ -853,6 +853,11 @@ No other settings should go into this file.
 Supply the config only to the tests that use `params`, otherwise define `params` for every test including the stub test.
 :::
 
+### Skipping CI test profiles
+
+If a module does not support a particular test profile, it can be skipped by adding the path to corresponding section in the `.github/skip_nf_test.json` file.
+Please keep the file sorted alphabetically by the path.
+
 ## Misc
 
 ### General module code formatting

diff --git a/sites/docs/src/content/docs/guidelines/components/subworkflows.md b/sites/docs/src/content/docs/guidelines/components/subworkflows.md
@@ -211,6 +211,11 @@ No other settings should go into this file.
 Supply the config only to the tests that use `params`, otherwise define `params` for every test including the stub test.
 :::
 
+## Skipping CI test profiles
+
+If a subworkflow does not support a particular test profile, it can be skipped by adding the path to the corresponding section in the `.github/skip_nf_test.json` file.
+Please keep the file sorted alphabetically by the path.
+
 ## Misc
 
 ### General module code formatting