nextflow
nextflow copied to clipboard
nextflow-io
Update plugins documentation
Deploy Preview for nextflow-docs-staging ready!
| Name | Link |
|---|---|
| Latest commit | 5b9874288ce3ec4a7ba01baecbbb09e9f36789ab |
| Latest deploy log | https://app.netlify.com/projects/nextflow-docs-staging/deploys/68b67c72e543060008ba2e5e |
| Deploy Preview | https://deploy-preview-6033--nextflow-docs-staging.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
When are we going to publish this? If the Gradle plugin only works with the plugin registry then it probably doesn't make sense to publish it until the plugin registry goes live.
My understanding is that make release works with the GitHub repo, so everything that is currently described is accurate. @tom-seqera , can you confirm?
We are not going to maintain support for uploading to Github. Documentation should only mention publishing to registry as private beta
FYI, I am taking a pass through this PR to clean up some things. Should be done by today.
Looking good so far.
The migration guide could use some more information about migrating to the plugin registry -- right now it only covers migrating to the gradle plugin but doesn't mention the fact that the Gradle plugin does not support publishing to GitHub, which is the most important point
FYI, I am taking a pass through this PR to clean up some things. Should be done by today.
Thanks @bentsherman
The migration guide could use some more information about migrating to the plugin registry
Would you like to draft and I clean it up, or is it easier if I draft in the PR and you clean it up?
Actually I don't think we have finalized the migration strategy for plugin developers. So this PR is blocked until we do that
I have updated the migration guide and various private beta callouts in such a way that I feel comfortable merging this PR now, even ahead of the plugin registry deployment.
To do this, I added a "Timeline" section to the migration guide which lays out our planned changes for the next few releases. This plan is taken from an internal planning doc where we reached some agreement.
The rest of the plugin docs direct you to this timeline via the callouts so that it's clear to anyone looking into the new Gradle plugin that there are some strings attached.
The tl;dr is that we will close the legacy plugin index to new PRs, but keep it in sync with the plugin registry for a time. Eventually after that, we can freeze the legacy index and remove it from new versions of Nextflow when we're ready.
This two-way sync during the transition period will make adopting the Gradle plugin as seamless as possible -- developers can use the new Gradle plugin with confidence that their plugin releases will continue to be accessible to users who aren't on the new registry yet.
I rebased the PR and squashed my commits to make it easier to maintain with master.
Also documented the NXF_PLUGINS_INDEX_URL which is how users opt-in to the plugin registry.
@christopher-hakkaart now that we have tutorials and guides, I'm not sure which one you intended for the gradle plugin / plugin registry pages. Also might be worth giving the PR another once-over since it was sitting for a while
Thanks @bentsherman . I'll go through the PR and think about where the pages live and look for anything that might be stale or don't make sense anymore.
@christopher-hakkaart i've updated the docs to reflect latests changes. see 0180c86