Skip to content

docs: Update migration note for plugin registry #6702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bentsherman wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −18
Open

docs: Update migration note for plugin registry #6702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions docs/migrations/25-10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,14 +194,8 @@ See {ref}`cli-auth` and {ref}`cli-launch` for details.

Nextflow now uses the [Nextflow plugin registry](https://registry.nextflow.io/) to download plugins in a more efficient and scalable manner.

The legacy plugin index can still be used by setting the `NXF_PLUGINS_REGISTRY_URL` environment variable:

```bash
export NXF_PLUGINS_REGISTRY_URL="https://raw.githubusercontent.com/nextflow-io/plugins/main/plugins.json"
```

Comment on lines -197 to -202
Copy link
Member

@pditommaso pditommaso Jan 6, 2026

Choose a reason for hiding this comment

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

Why is this removed?

nextflow/modules/nf-commons/src/main/nextflow/plugin/PluginsFacade.groovy

Lines 125 to 129 in 68d7544

final url = env.get('NXF_PLUGINS_REGISTRY_URL')
if( !url ) {
log.trace "Using default plugins url: ${NEXTFLOW_PLUGINS_REPO}"
return NEXTFLOW_PLUGINS_REPO
}

Copy link
Member Author

@bentsherman bentsherman Jan 6, 2026

Choose a reason for hiding this comment

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

I thought you said that 25.10 doesn't support the legacy index? Isn't that why we don't publish plugins requiring >=25.10 to the legacy index?

Copy link
Member

@pditommaso pditommaso Jan 7, 2026

Choose a reason for hiding this comment

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

I got your point, however technically both NXF_PLUGINS_TEST_REPOSITORY and NXF_PLUGINS_REGISTRY_URL are still there

Copy link
Member Author

@bentsherman bentsherman Jan 7, 2026

Choose a reason for hiding this comment

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

Then I am confused. Does 25.10 still support the legacy index or not?

:::{note}
Plugin developers will not be able to submit PRs to the legacy plugin index once the plugin registry is generally available. Plugins should be updated to publish to the Nextflow plugin registry using the {ref}`Nextflow Gradle plugin <gradle-plugin-page>` instead. See {ref}`plugin-registry-page` for details.
Plugins should be updated to publish to the Nextflow plugin registry using the {ref}`Nextflow Gradle plugin <gradle-plugin-page>` instead of the legacy plugin index. See {ref}`plugin-registry-page` for details.
:::

<h3>New syntax for workflow handlers</h3>
Expand Down
18 changes: 7 additions & 11 deletions docs/reference/env-vars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,6 @@ The following environment variables control the configuration of the Nextflow ru
: Default `organization` prefix when looking for a hosted repository (default: `nextflow-io`).

`NXF_PARAMS_FILE`
: :::{versionadded} 20.10.0
:::
: Defines the path location of the pipeline parameters file .

`NXF_PID_FILE`
Expand All @@ -167,7 +165,7 @@ The following environment variables control the configuration of the Nextflow ru
: The path where the plugin archives are loaded and stored (default: `$NXF_HOME/plugins`).

`NXF_PLUGINS_REGISTRY_URL`
: :::{versionadded} 25.08.0-edge
: :::{versionadded} 25.10.0
:::
: Specifies the URL of the plugin registry used to download and resolve plugins. This allows using custom or private plugin registries instead of the default public registry.

Expand All @@ -182,34 +180,32 @@ The following environment variables control the configuration of the Nextflow ru
: Defines the default behavior of `publishDir.failOnError` setting. See {ref}`publishDir<process-publishdir>` directive for more information.

`NXF_RETRY_POLICY_DELAY`
: :::{versionadded} 25.06.0-edge
: :::{versionadded} 25.10.0
:::
: Delay used for HTTP retryable operations (default: `350ms`).

`NXF_RETRY_POLICY_JITTER`
: :::{versionadded} 25.06.0-edge
: :::{versionadded} 25.10.0
:::
: Jitter value used for HTTP retryable operations (default: `0.25`).

`NXF_RETRY_POLICY_MAX_ATTEMPTS`
: :::{versionadded} 25.06.0-edge
: :::{versionadded} 25.10.0
:::
: Max number of attempts used for HTTP retryable operations (default: `5`).

`NXF_RETRY_POLICY_MAX_DELAY`
: :::{versionadded} 25.06.0-edge
: :::{versionadded} 25.10.0
:::
: Max delay used for HTTP retryable operations (default: `90s`).

`NXF_RETRY_POLICY_MULTIPLIER`
: :::{versionadded} 25.08.0-edge
: :::{versionadded} 25.10.0
:::
: Delay multiplier used for HTTP retryable operations (default: `2.0`).

`NXF_SCM_FILE`
: :::{versionadded} 20.10.0
:::
: Defines the path location of the SCM config file .
: Defines the path location of the SCM config file.
Copy link
Collaborator

@christopher-hakkaart christopher-hakkaart Jan 5, 2026

Choose a reason for hiding this comment

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

Suggested change
: Defines the path location of the SCM config file.
: The path location of the SCM config file.


`NXF_SINGULARITY_CACHEDIR`
: Directory where remote Singularity images are stored. When using a computing cluster it must be a shared folder accessible from all compute nodes.
Expand Down
Loading