Skip to content

Update plugins documentation #6033

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

Open
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

christopher-hakkaart
Copy link
Collaborator

No description provided.

Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Signed-off-by: Christopher Hakkaart <[email protected]>
Copy link

netlify bot commented May 5, 2025

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit d011970
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/681eba2ac6f2cb0008103097
😎 Deploy Preview https://deploy-preview-6033--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ewels ewels mentioned this pull request May 5, 2025
Signed-off-by: Christopher Hakkaart <[email protected]>
@bentsherman
Copy link
Member

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.

@christopher-hakkaart
Copy link
Collaborator Author

christopher-hakkaart commented May 6, 2025

My understanding is that make release works with the GitHub repo, so everything that is currently described is accurate. @tom-seqera , can you confirm?

@pditommaso
Copy link
Member

We are not going to maintain support for uploading to Github. Documentation should only mention publishing to registry as private beta

@bentsherman
Copy link
Member

FYI, I am taking a pass through this PR to clean up some things. Should be done by today.

Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
@bentsherman
Copy link
Member

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

@christopher-hakkaart
Copy link
Collaborator Author

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?

@bentsherman
Copy link
Member

Actually I don't think we have finalized the migration strategy for plugin developers. So this PR is blocked until we do that

@bentsherman bentsherman self-assigned this May 9, 2025
@bentsherman bentsherman marked this pull request as ready for review May 9, 2025 21:57
@bentsherman bentsherman requested a review from a team as a code owner May 9, 2025 21:57
@bentsherman bentsherman requested a review from pditommaso May 9, 2025 21:57
@bentsherman
Copy link
Member

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.

Copy link
Collaborator Author

@christopher-hakkaart christopher-hakkaart left a comment

Choose a reason for hiding this comment

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

I've added a few suggestions. Mostly removing words.

I would unlist the timeline H3 headings so they don't clutter the side navigation. But everything is optional if you think meaning is lost.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants