Share build plugins

If you'd like to share your plugin with others, you can publish it to npm. All Netlify Build plugins in the npm Public Registry can be installed by any Netlify user via file-based installation. To make your plugin available in the Netlify UI, you can submit it to the Netlify plugins directory.

Publish to npm

To publish a build plugin to npm, follow npm's documentation for contributing packages to the registry.

Be sure to add the following properties to your plugin's package.json file:

  • name should start with netlify-plugin- (such as netlify-plugin-example or @scope/netlify-plugin-example). It should match the plugin name field. It is recommended for the plugin repository to be named like this as well.
  • keywords should contain the netlify and netlify-plugin keywords. The same applies to GitHub topics. This helps users find your plugin.
  • repository and bugs should be defined. Those are displayed to users when an error occurs inside your plugin.

Submit to the plugins directory

The Netlify plugins directory is generated from a plugins.json files stored in a public repository, https://github.com/netlify/plugins.

The repository includes a contributor guide with instructions for preparing your plugin and submitting it in a pull request to the repository. As noted in the guide, you'll also need to read and follow the plugin author guidelines before submitting.