From 8b3c3bbed3019fda51bc8d8c57a13f253748c579 Mon Sep 17 00:00:00 2001 From: mirpedrol Date: Thu, 12 Oct 2023 08:46:01 +0200 Subject: [PATCH 1/2] bump to 1.0.0 --- CHANGELOG.md | 7 +++++++ plugins/nf-validation/src/resources/META-INF/MANIFEST.MF | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ba61538..dbaf0198 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,17 @@ # Version 1.0.0 +This version introduces a change of syntax when providing optional arguments to the functions. You can now provide optional arguments such as the nextflow parameters schema path as: +`validateParameters(parameters_schema: 'my_file.json')` + +## Bug fixes + - The path to a custom parameters schema must be provided through a map '`parameters_schema: 'my_file.json'`' in `validateParameters()` and `paramsSummaryMap()` ([#108](https://github.com/nextflow-io/nf-validation/pull/108)) # Version 0.3.4 +This version introduced a bug which made all pipeline runs using the function `validateParameters()` without providing any arguments fail. + ### Bug fixes - Do not check S3 URL paths with `PathValidator` `FilePathValidator` and `DirectoryPathValidator` ([#106](https://github.com/nextflow-io/nf-validation/pull/106)) diff --git a/plugins/nf-validation/src/resources/META-INF/MANIFEST.MF b/plugins/nf-validation/src/resources/META-INF/MANIFEST.MF index 77c89abb..a35a7a11 100644 --- a/plugins/nf-validation/src/resources/META-INF/MANIFEST.MF +++ b/plugins/nf-validation/src/resources/META-INF/MANIFEST.MF @@ -1,6 +1,6 @@ Manifest-Version: 1.0 Plugin-Id: nf-validation -Plugin-Version: 0.3.4 +Plugin-Version: 1.0.0 Plugin-Class: nextflow.validation.ValidationPlugin Plugin-Provider: nextflow Plugin-Requires: >=22.10.0 From 7d13da4da40e18a808b43dfc25815f99b46d84aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BAlia=20Mir=20Pedrol?= Date: Thu, 12 Oct 2023 09:24:02 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Phil Ewels --- CHANGELOG.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dbaf0198..f7e3d89d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,13 @@ # Version 1.0.0 -This version introduces a change of syntax when providing optional arguments to the functions. You can now provide optional arguments such as the nextflow parameters schema path as: +The nf-validation plugin is now in production use across many pipelines and has (we hope) now reached a point of relative stability. The bump to major version v1.0.0 signifies that it is suitable for use in production pipelines. + +This version also introduces a small breaking change of syntax when providing optional arguments to the functions. You can now provide optional arguments such as the nextflow parameters schema path as: `validateParameters(parameters_schema: 'my_file.json')` +(previous syntax used positional arguments instead). + ## Bug fixes - The path to a custom parameters schema must be provided through a map '`parameters_schema: 'my_file.json'`' in `validateParameters()` and `paramsSummaryMap()` ([#108](https://github.com/nextflow-io/nf-validation/pull/108)) @@ -13,6 +17,8 @@ This version introduces a change of syntax when providing optional arguments to This version introduced a bug which made all pipeline runs using the function `validateParameters()` without providing any arguments fail. +This bug causes Nextflow to exit with an error on launch for most pipelines. It should not be used. It was [removed](https://github.com/nextflow-io/plugins/pull/40) from the Nextflow Plugin registry to avoid breaking people's runs. + ### Bug fixes - Do not check S3 URL paths with `PathValidator` `FilePathValidator` and `DirectoryPathValidator` ([#106](https://github.com/nextflow-io/nf-validation/pull/106))