Skip to content

Commit 4c57cbf

Browse files
committed
Document the secret Nextflow directive
1 parent 387f446 commit 4c57cbf

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

src/main/scala/io/viash/runners/nextflow/NextflowDirectives.scala

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,23 @@ case class NextflowDirectives(
310310
@default("Empty")
311311
queue: OneOrMore[String] = Nil,
312312

313+
@description(
314+
"""The `secret` directive allows you to use a Nextflow secret in a process. Secrets are
315+
|injected into the process as environment variables and can be referenced in scripts
316+
|as `$SECRET_NAME`.
317+
|
318+
|Secrets must be configured beforehand using the `nextflow secrets set` CLI command.
319+
|
320+
|Note: this directive is not supported by cloud-native executors (e.g. AWS Batch, Google Batch)
321+
|without Seqera Platform. Available from Nextflow 22.10.
322+
|
323+
|See [`secret`](https://nextflow.io/docs/latest/reference/process.html#secret).
324+
|""")
325+
@example(""""MY_ACCESS_KEY"""", "yaml")
326+
@example("""["MY_ACCESS_KEY", "MY_SECRET_KEY"]""", "yaml")
327+
@default("Empty")
328+
secret: OneOrMore[String] = Nil,
329+
313330
@description(
314331
"""The `scratch` directive allows you to execute the process in a temporary folder that is local to the execution node.
315332
|

0 commit comments

Comments
 (0)