Skip to content

Commit

Permalink
Update syntax in documentation for requires
Browse files Browse the repository at this point in the history
  • Loading branch information
lukfor committed May 14, 2024
1 parent bd59031 commit e4f8772
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The `nf-test.config` file is a configuration file used to customize settings and behavior for `nf-test`. This file must be located in the root of your project, and it is automatically loaded when you run `nf-test test`. Below are the parameters that can be adapted:

| Parameter | Description | Default Value |
|--------------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------- |
| `testsDir` | Location for storing all nf-test cases (test scripts). If you want all test files to be in the same directory as the script itself, you can set the testDir to `.` | `"tests"` |
| `workDir` | Directory for storing temporary files and working directories for each test. This directory should be added to `.gitignore`. | `".nf-test"` |
| `configFile` | Location of an optional `nextflow.config` file specifically used for executing tests. [Learn more](#testsnextflowconfig). | `"tests/nextflow.config"` |
Expand All @@ -14,6 +14,8 @@ The `nf-test.config` file is a configuration file used to customize settings and
| `withTrace` | Enable or disable tracing options during testing. Disable tracing if your containers don't include the `procps` tool. | `true` |
| `autoSort` | Enable or disable sorted channels by default when running tests. | `true` |
| `options` | Custom Nextflow command-line options to be applied when running tests. For example `"-dump-channels -stub-run"` | |
| `requires` | Can be used to specify the minimum required version of nf-test. Requires nf-test > 0.9.0 | |


Here's an example of what an `nf-test.config` file could look like:

Expand All @@ -35,9 +37,9 @@ For instance, to ensure the use of at least nf-test version 0.9.0, define it as

```groovy
config {
requires {
requires (
"nf-test": "0.9.0"
}
)
}
```

Expand Down

0 comments on commit e4f8772

Please sign in to comment.