Skip to content

Commit

Permalink
update changelog + prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
nvnieuwk committed Apr 19, 2024
1 parent 30614ab commit 67bd718
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ To migrate from nf-validation please follow the [migration guide](https://nextfl

- Added the `uniqueEntries` keyword. This keyword takes a list of strings corresponding to names of fields that need to be a unique combination. e.g. `uniqueEntries: ['sample', 'replicate']` will make sure that the combination of the `sample` and `replicate` fields is unique. ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
- Added `samplesheetToList` which is the function equivalent of `.fromSamplesheet` [#3](https://github.com/nextflow-io/nf-schema/pull/3)
- Added a warning if the `nf-schema` version is unpinned. Let's hope this prevents future disasters like the release of `nf-validation` v2.0 :grin:

## Changes

Expand All @@ -17,6 +18,7 @@ To migrate from nf-validation please follow the [migration guide](https://nextfl
- Removed the `skip_duplicate_check` option from the `samplesheetToList()` function and the `--validationSkipDuplicateCheck` parameter. You should now use the `uniqueEntries` or [`uniqueItems`](https://json-schema.org/understanding-json-schema/reference/array#uniqueItems) keywords in the schema instead ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
- `samplesheetToList()` now does dynamic typecasting instead of using the `type` fields in the JSON schema. This is done due to the complexity of `draft-2020-12` JSON schemas. This should not have that much impact but keep in mind that some types can be different between this version and older versions in nf-validation ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
- `samplesheetToList()` will now set all missing values as `[]` instead of the type specific defaults (because of the changes in the previous point). This should not change that much as this will also result in `false` when used in conditions. ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
- Removed the configuration parameters and added configuration options instead. For a full list of these new options, please have a look at the [configuration docs](https://nextflow-io.github.io/nf-schema/latest/configuration/)

## Improvements

Expand Down
3 changes: 2 additions & 1 deletion docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The plugin can be configured using several configuration options. These options
```groovy
validation.<option> = <value>
```

OR

```groovy
Expand Down Expand Up @@ -69,4 +70,4 @@ This option does exactly the same as `validation.ignoreParams`, but provides pip

```groovy
validation.defaultIgnoreParams = ["param1", "param2"] // default: []
```
```
4 changes: 2 additions & 2 deletions docs/migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ validation {

See this table for an overview of what the new configuration options are for the old parameters

| Old parameter | New config option(s) |
| -------------------------------------------- | -------------------------------------------------------------------------------- |
| Old parameter | New config option(s) |
| ----------------------------------------------------- | -------------------------------------------------------------------------------- |
| `params.validationMonochromeLogs = <boolean>` | `validation.monochromeLogs = <boolean>` |
| `params.validationLenientMode = <boolean>` | `validation.lenientMode = <boolean>` |
| `params.validationFailUnrecognisedParams = <boolean>` | `validation.failUnrecognisedParams = <boolean>` |
Expand Down

0 comments on commit 67bd718

Please sign in to comment.