The IF Explorer is where builders share their plugins with the world.
If you are a plugin builder, share your work with others, gain exposure for your work and contribute to the IF ecosystem by submitting your plugin to the Explorer.
If you are an IF user, the Explorer is where you can browse or search for the plugins you need for your specific pipeline.
How to submit plugins to the Explorer
Submitting plugins to the Explorer is as easy as filling in the form below!
Before you submit the form, please make sure your plugin code and documentation is ready.
Specifically, we want to see the following items in your project README:
- A list of the parameters and return values.
- A list of required and optional configuration
- A description of any environment setup.
- Installation instructions
- A written description of the plugin behaviour
- A list of errors that your plugin can raise.
- A demo manifest that executes the plugin
Here is a README template to help you organize this information.
You can see how the README should look by browsing our IF builtins directory, for example our Interpolation builtin.
We would much prefer each plugin to have its own repository and independent documentation. This means we can provide one card per plugin on the website and users will be able to find the plugin they are looking for more easily.
How to build a plugin
You can develop your own plugins and use them in a pipeline.
You can find a step-by-step tutorial for building plugins on our documentation website.
We also provide a plugin template repository that you can use to bootstrap your plugin development.
Disclaimer
PLEASE BE ADVISED THAT IF YOU RUN CODE INCLUDED IN THESE PLUGINS OR USE INFORMATION GENERATED BY THESE PLUGINS, INCLUDING MAKING ANY DECISIONS BASED UPON THE INFORMATION, YOU DO SO AT YOUR OWN RISK. GREEN SOFTWARE FOUNDATION MAKES NO REPRESENTATION, GUARANTEE OR WARRANTY, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, INCLUDING MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE NOR ANY WARRANTIES ARISING FROM COURSE OF PERFORMANCE, COURSE OF DEALING OR USAGE IN TRADE.
By submitting your plugin you confirm that you do not know of any specific security vulnerability in your plugin code and that your plugin works as described.