-
Notifications
You must be signed in to change notification settings - Fork 762
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.
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
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Ben Sherman <[email protected]>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
christopher-hakkaart
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved from an editorial perspective. One minor suggestion to align with the direction we are taking for reference/definition lists.
Will need someone else to confirm the content is accurate as of 25.10
| : :::{versionadded} 20.10.0 | ||
| ::: | ||
| : Defines the path location of the SCM config file . | ||
| : Defines the path location of the SCM config file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| : Defines the path location of the SCM config file. | |
| : The path location of the SCM config file. |
pditommaso
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can the NXF_PLUGINS_TEST_REPOSITORY env var still be used? If not then we should add a deprecation note
it should be still in place
| final repos = SysEnv.get('NXF_PLUGINS_TEST_REPOSITORY') |
| 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" | ||
| ``` | ||
|
|
There was a problem hiding this comment.
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 | |
| } |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
The 25.10 migration notes currently say that the legacy plugin index can still be used, but AFAIK this support was completely removed in 25.10
@pditommaso can the
NXF_PLUGINS_TEST_REPOSITORYenv var still be used? If not then we should add a deprecation note