Skip to content

Conversation

@pditommaso
Copy link
Member

@pditommaso pditommaso commented Dec 13, 2025

Summary

  • Add README.md files for all 9 plugins following the nextflow-plugin-gradle requirements
  • Each README includes: Summary, Get Started, Examples, Resources, and License sections
  • Disable generateSpec in build.gradle for all plugins

Changes

New README files

  • plugins/nf-amazon/README.md
  • plugins/nf-azure/README.md (updated)
  • plugins/nf-cloudcache/README.md
  • plugins/nf-codecommit/README.md
  • plugins/nf-console/README.md
  • plugins/nf-google/README.md
  • plugins/nf-k8s/README.md
  • plugins/nf-tower/README.md
  • plugins/nf-wave/README.md

Build configuration

  • Added generateSpec = false to all plugin build.gradle files

Test plan

  • Verify README files are correctly formatted
  • Run ./gradlew releasePluginToRegistryIfNotExists to verify plugin release works

🤖 Generated with Claude Code

@netlify
Copy link

netlify bot commented Dec 13, 2025

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit baa9f0b
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/694267f6d1a4b90008912188

- Add README.md files for all plugins following the nextflow-plugin-gradle requirements
- Each README includes: Summary, Get Started, Examples, Resources, and License sections
- Disable generateSpec in build.gradle for all plugins (temporary workaround)

Signed-off-by: Paolo Di Tommaso <[email protected]>
Copy link
Collaborator

@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 some suggestions to name the plugin in the first sentence to improve clarity, but otherwise looks good.

pditommaso and others added 9 commits December 15, 2025 09:15
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
@pditommaso
Copy link
Member Author

Awesome thanks

Signed-off-by: Paolo Di Tommaso <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
@pditommaso pditommaso requested a review from a team as a code owner December 16, 2025 17:56
Copy link
Collaborator

@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 suggestions to change the headings into sentence case, which we use for regular documentation.

Copy link
Collaborator

@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 suggestions to change the headings into sentence case, which we use for regular documentation.

pditommaso and others added 5 commits December 17, 2025 09:18
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
pditommaso and others added 4 commits December 17, 2025 09:20
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
Co-authored-by: Chris Hakkaart <[email protected]>
Signed-off-by: Paolo Di Tommaso <[email protected]>
@pditommaso pditommaso merged commit bee8cff into master Dec 17, 2025
14 checks passed
@pditommaso pditommaso deleted the add-plugin-readmes branch December 17, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants