Skip to content

nextflow-io/nf-plugin-template

Repository files navigation

nf-plugin-template plugin

Building

To build the plugin:

make assemble

Testing with Nextflow

The plugin can be tested without a local Nextflow installation:

  1. Build and install the plugin to your local Nextflow installation: make install
  2. Run a pipeline with the plugin: nextflow run hello -plugins [email protected]

Publishing

Plugins can be published to a central plugin registry to make them accessible to the Nextflow community.

Follow these steps to publish the plugin to the Nextflow Plugin Registry:

  1. Create a file named $HOME/.gradle/gradle.properties, where $HOME is your home directory. Add the following properties:

    • pluginRegistry.accessToken: Your Nextflow Plugin Registry access token.
  2. Use the following command to package and create a release for your plugin on GitHub: make release.

Note

The Nextflow Plugin registry is currently available as private beta technology. Contact [email protected] to learn how to get access to it.

About

Template project for creating Nextflow plugins (beta)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •