This repository has been archived by the owner on Aug 20, 2024. It is now read-only.
forked from nextflow-io/nf-schema
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Get it working hopefully on both GitHub + mkdocs
- Loading branch information
Showing
2 changed files
with
12 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,5 @@ | ||
# ![nf-validation](docs/images/nf-validation.svg) | ||
|
||
## π Docs ππ» <https://nextflow-io.github.io/nf-validation> | ||
|
||
!!! warning | ||
|
||
<div class="admonition warning" markdown> | ||
|
||
<!-- prettier-ignore --> | ||
> [!IMPORTANT] | ||
> **`nf-validation` has now been renamed to `nf-schema`. The `nf-validation` plugin will not receive any future updates.** | ||
|
@@ -17,7 +11,7 @@ | |
> plugins { id '[email protected]' } | ||
> ``` | ||
</div> | ||
## π Docs ππ» <https://nextflow-io.github.io/nf-validation> | ||
|
||
**A Nextflow plugin to work with validation of pipeline parameters and sample sheets.** | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,4 +11,14 @@ description: Nextflow plugin for sample sheet validation | |
|
||
==} | ||
|
||
--8<-- "README.md:6:" | ||
!!! warning "`nf-validation` has now been renamed to `nf-schema`." | ||
|
||
**`nf-validation` has now been renamed to `nf-schema`. The `nf-validation` plugin will not receive any future updates.** | ||
**Please update your pipelines to use [`nf-schema`](https://github.com/nextflow-io/nf-schema) instead.** | ||
This change was necessary to prevent older versions of `nf-core` pipelines from with unpinned plugin references from breaking when updating to the latest version of `nf-validation`. | ||
**Please pin the version of `nf-schema` in your pipeline's `nextflow.config` file:** | ||
```nextflow | ||
plugins { id '[email protected]' } | ||
``` | ||
|
||
--8<-- "README.md:18:" |