Update docs to include parameter --outdir (#9)

.github/workflows/nf-test.yml

@@ -1,4 +1,4 @@
-name: nf-test
+name: test
 on:
   push:
     branches: [main]
@@ -14,7 +14,7 @@ on:
 
 # Cancel if a newer run is started
 concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:

README.md

@@ -91,7 +91,11 @@ This process stages a folder from the working directory to the worker node, copi
 
 ### `TEST_PUBLISH_FILE`
 
-This process creates a file on the worker machine, then writes that file to the publishDir directory. This is the by default written to an subfolder called `output` in the working directory.
+This process creates a file on the worker machine, then writes that file to the publishDir directory. This is the by default written to an subfolder called `output` in the working directory, but this can be overridden using the parameter `outdir`. Use this to demonstrate you are able to publish to the relevant output directory.
+
+### `TEST_PUBLISH_FOLDER`
+
+This process creates a folder on the worker machine, then writes that folder to the publishDir directory. This is the by default written to an subfolder called `output` in the working directory, but this can be overridden using the parameter `outdir`. Use this to demonstrate you are able to publish to the relevant output directory.
 
 ### `TEST_IGNORED_FAIL`
 

nextflow_schema.json

@@ -4,17 +4,35 @@
   "title": ". pipeline parameters",
   "description": "",
   "type": "object",
-  "properties": {
-    "skip": {
-      "type": "string",
-      "description": "Tests to skip as comma delimited values.",
-      "help_text": "Tests to skip as comma delimited values. E.g. --skip TEST_SUCCESS,TEST_INPUT. Case insensitive."
-    },
-    "remoteFile": {
-      "type": "string",
-      "description": "Path to remote file to download and use.",
-      "help_text": "Path to a remote file to use within the pipeline. This mimics a remote set of files such as reference data that may need to be retrieved prior to analysis. By default this is not specified and the test is not ran, add a remote file using standard Nextflow filenaming to pull a file from your storage (e.g. an S3 bucket or shared storage).",
-      "format": "path"
+  "definitions": {
+    "parameters": {
+      "title": "Parameters",
+      "type": "object",
+      "description": "",
+      "default": "",
+      "properties": {
+        "skip": {
+          "type": "string",
+          "description": "Tests to skip as comma delimited values.",
+          "help_text": "Tests to skip as comma delimited values. E.g. --skip TEST_SUCCESS,TEST_INPUT. Case insensitive."
+        },
+        "remoteFile": {
+          "type": "string",
+          "description": "Path to remote file to download and use.",
+          "help_text": "Path to a remote file to use within the pipeline. This mimics a remote set of files such as reference data that may need to be retrieved prior to analysis. By default this is not specified and the test is not ran, add a remote file using standard Nextflow filenaming to pull a file from your storage (e.g. an S3 bucket or shared storage).",
+          "format": "path"
+        },
+        "outdir": {
+          "type": "string",
+          "description": "Path to use for publishing output files.",
+          "help_text": "Path to a remote folder to publish files to. If not specified, this is a subfolder within the working directory but if specified it will publish files to the path specified in this parameter."
+        }
+      }
     }
-  }
+  },
+  "allOf": [
+    {
+      "$ref": "#/definitions/parameters"
+    }
+  ]
 }