How do I add my plugin to the plugin portal?

Note: if you have previously published Gradle plugins via Bintray, please read this information.

Step 1: Create an account.

You can quickly and easily create a new account via the registration page.

You can use the same account to publish as many plugins as you like.

Step 2: Create an API key.

Once logged in, you can get your API key via the “API Keys” tab of your profile page.

You can use the same API key to publish as many plugins as you like.

Step 3: Add your API key to your Gradle configuration.

Once you've created an API key, the “API Keys” tab of your profile page will provide a snippet that you can copy & paste into your Gradle user properties file.

The default location for the Gradle user properties file is $USER_HOME/.gradle/gradle.properties, where $USER_HOME refers to your user home directory.

There is also an experimental task, “login“, that is part of the plugin publishing plugin, which automates this step. You need to follow the reference documentation to see how to configure this plugin.

Step 4: Use the plugin publishing plugin.

The plugin publishing plugin provides tasks that upload your plugin to the plugin portal. It can also be used to publish updated versions of your plugin in the future.

This plugin allows you to specify the ID, description, tags and other information about your plugin. This information can also be edited later after the plugin has been published.

Please see the reference documentation for the plugin for how to configure and use this plugin.

Step 5: You're done.

Your plugin is now part of the Gradle Plugin Portal and can be put to use by Gradle users all over the world.

Thank you for contributing.

Some plugins require manual acceptance by the Plugin Portal maintainers, and will not be made available immediately when they are published. This is only the case when you have specified a custom “group ID” for your plugin artifact. The plugin publishing plugin will tell you if your plugin is pending acceptance when you publish.

If your plugin requires changes before it can be accepted, you will be contacted via the email address associated with your account. You will also receive an email when your plugin is accepted.