Merge pull request #170 from nextflow-io/prepare-for-deprecation

Prepare for deprecation of nf-validation

README.md

@@ -1,5 +1,16 @@
 # ![nf-validation](docs/images/nf-validation.svg)
 
+<!-- prettier-ignore -->
+> [!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.**

docs/index.md

@@ -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:"

mkdocs.yml

@@ -28,6 +28,7 @@ nav:
 
 theme:
   name: material
+  custom_dir: overrides
   icon:
     logo: octicons/checklist-16
     repo: fontawesome/brands/github

overrides/main.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block announce %}
+  <div style="text-align: center;">
+    <strong>nf-validation has been deprecated.</strong>
+    Please use <a href="https://nextflow-io.github.io/nf-schema/latest/">nf-schema</a> instead.
+  </div>
+{% endblock %}