Skip to content
This repository was archived by the owner on Aug 20, 2024. It is now read-only.

Commit 1ef8887

Browse files
committed
revert to v1.1.3
1 parent 922bb6f commit 1ef8887

File tree

96 files changed

+1411
-2968
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+1411
-2968
lines changed

.github/workflows/build-docs.yml

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,15 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/checkout@v3
15-
with:
16-
fetch-depth: 0 # fetch all commits/branches
1715
- uses: actions/setup-python@v4
1816
with:
1917
python-version: 3.x
2018
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21-
- name: Obtain version from MANIFEST.MF
22-
run: echo "plugin_version=$(grep "Plugin-Version" plugins/nf-validation/src/resources/META-INF/MANIFEST.MF | awk '{print $2}' | awk -F '.' '{print $1"."$2}')" >> $GITHUB_ENV
23-
- name: Setup git user
24-
run: |
25-
git config --global user.name "${{github.actor}}"
26-
git config --global user.email "${{github.actor}}@users.noreply.github.com"
2719
- uses: actions/cache@v3
2820
with:
2921
key: mkdocs-material-${{ env.cache_id }}
3022
path: .cache
3123
restore-keys: |
3224
mkdocs-material-
33-
- name: Install dependencies
34-
run: pip install mkdocs-material pymdown-extensions pillow cairosvg mike
35-
- name: Build docs
36-
run: mike deploy --push --update-aliases ${{ env.plugin_version }} latest
37-
- name: Set default docs
38-
run: mike set-default --push latest
25+
- run: pip install mkdocs-material pymdown-extensions pillow cairosvg
26+
- run: mkdocs gh-deploy --force

.gitpod.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,5 @@
11
# nextflow-io/nf-validation: Changelog
22

3-
# Version 2.0.0 - Kagoshima
4-
5-
:warning: This version contains a number of breaking changes. Please read the changelog carefully before upgrading. :warning:
6-
7-
To migrate your schemas please follow the [migration guide](https://nextflow-io.github.io/nf-validation/latest/migration_guide/)
8-
9-
## New features
10-
11-
- 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))
12-
13-
## Changes
14-
15-
- Changed the used draft for the schema from `draft-07` to `draft-2020-12`. See the [2019-09](https://json-schema.org/draft/2019-09/release-notes) and [2020-12](https://json-schema.org/draft/2020-12/release-notes) release notes for all changes ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
16-
- Removed all validation code from the `.fromSamplesheet()` channel factory. The validation is now solely done in the `validateParameters()` function. A custom error message will now be displayed if any error has been encountered during the conversion ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
17-
- Removed the `unique` keyword from the samplesheet schema. You should now use [`uniqueItems`](https://json-schema.org/understanding-json-schema/reference/array#uniqueItems) or `uniqueEntries` instead ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
18-
- Removed the `skip_duplicate_check` option from the `fromSamplesheet()` channel factory 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))
19-
- `.fromSamplesheet()` 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 and earlier versions because of this ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
20-
- `.fromSamplesheet()` 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))
21-
22-
## Improvements
23-
24-
- Setting the `exists` keyword to `false` will now check if the path does not exist ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
25-
- The `schema` keyword will now work in all schemas. ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
26-
- Improved the error messages ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
27-
- `.fromSamplesheet()` now supports deeply nested samplesheets ([#141](https://github.com/nextflow-io/nf-validation/pull/141))
28-
293
# Version 1.1.3 - Asahikawa
304

315
## Improvements

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This [Nextflow plugin](https://www.nextflow.io/docs/latest/plugins.html#plugins)
1414
- 📋 Validate the contents of supplied sample sheet files
1515
- 🛠️ Create a Nextflow channel with a parsed sample sheet
1616

17-
Supported sample sheet formats are CSV, TSV, JSON and YAML.
17+
Supported sample sheet formats are CSV, TSV and YAML (simple).
1818

1919
## Quick Start
2020

@@ -31,7 +31,7 @@ This is all that is needed - Nextflow will automatically fetch the plugin code a
3131
> [!NOTE]
3232
> The snippet above will always try to install the latest version, good to make sure
3333
> that the latest bug fixes are included! However, this can cause difficulties if running
34-
> offline. You can pin a specific release using the syntax `nf-validation@2.0.0`
34+
> offline. You can pin a specific release using the syntax `nf-validation@0.3.2`
3535
3636
You can now include the plugin helper functions into your Nextflow pipeline:
3737

@@ -58,7 +58,7 @@ ch_input = Channel.fromSamplesheet("input")
5858
## Dependencies
5959

6060
- Java 11 or later
61-
- <https://github.com/harrel56/json-schema>
61+
- <https://github.com/everit-org/json-schema>
6262

6363
## Slack channel
6464

@@ -75,4 +75,3 @@ We would like to thank the key contributors who include (but are not limited to)
7575
- Nicolas Vannieuwkerke ([@nvnieuwk](https://github.com/nvnieuwk))
7676
- Kevin Menden ([@KevinMenden](https://github.com/KevinMenden))
7777
- Phil Ewels ([@ewels](https://github.com/ewels))
78-
- Arthur ([@awgymer](https://github.com/awgymer))

docs/migration_guide.md

Lines changed: 0 additions & 165 deletions
This file was deleted.

docs/nextflow_schema/create_schema.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,6 @@ go to the pipeline root and run the following:
4646
nf-core schema build
4747
```
4848

49-
!!! warning
50-
51-
The current version of `nf-core` tools (v2.12.1) does not support the new schema draft used in `nf-validation`. Running this command after building the schema will convert the schema to the right draft:
52-
53-
```bash
54-
sed -i -e 's/http:\/\/json-schema.org\/draft-07\/schema/https:\/\/json-schema.org\/draft\/2020-12\/schema/g' -e 's/definitions/defs/g' nextflow_schema.json
55-
```
56-
A new version of the nf-core schema builder will be available soon. Keep an eye out!
57-
5849
The tool will run the `nextflow config` command to extract your pipeline's configuration
5950
and compare the output to your `nextflow_schema.json` file (if it exists).
6051
It will prompt you to update the schema file with any changes, then it will ask if you

0 commit comments

Comments
 (0)