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

Add deprecation message to the nf-validation docs #163

Closed
wants to merge 4 commits into from
Closed

Add deprecation message to the nf-validation docs #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b32bdf
test the readme
nvnieuwk Mar 14, 2024
ad8f7cc
try to fix the text block
nvnieuwk Mar 14, 2024
3e63ac5
prettier
nvnieuwk Mar 14, 2024
be217ca
disable docs building
nvnieuwk Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/workflows/build-docs.yml → .github/disabled_workflows/build-docs.yml
View file
Open in desktop
File renamed without changes.
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# ![nf-validation](docs/images/nf-validation.svg)

> [!IMPORTANT] **`nf-validation` has now been deprecated and won't be updated anymore.**
>
> **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 breaking when updating to the latest version of `nf-validation`. Some older and current versions of the pipelines did not pin the version of nf-validation, which caused the pipelines to break when the latest version of nf-validation was released. This change will prevent this from happening in the future. **Please pin the version of `nf-schema` in your pipeline's `nextflow.config` file.**
Comment on lines +3 to +7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't render properly. The admonition type needs to be on it's own line.

Suggested change
> [!IMPORTANT] **`nf-validation` has now been deprecated and won't be updated anymore.**
>
> **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 breaking when updating to the latest version of `nf-validation`. Some older and current versions of the pipelines did not pin the version of nf-validation, which caused the pipelines to break when the latest version of nf-validation was released. This change will prevent this from happening in the future. **Please pin the version of `nf-schema` in your pipeline's `nextflow.config` file.**
> [!IMPORTANT]
> **`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]' }
> ```


## 📚 Docs 👉🏻 <https://nextflow-io.github.io/nf-validation>

**A Nextflow plugin to work with validation of pipeline parameters and sample sheets.**
Expand Down
Loading