Publishing Your Plugin

Publishing your plugin on the site is a three step process:

Add a Service Hook

First, you'll need to enable the jQuery Plugins service hook on GitHub. On the settings page for your repository, click the Webhooks & Services link, thenclick the Configure services button. Scroll down to find the jQuery Pluginsservice and enable it (there's no config, just check the Active checkbox andclick the Update settings button).

Add a Manifest to your Repository

The jQuery Plugins Registry will look in the root level of your repository forany files named *.jquery.json. You will want to create *yourplugin*.jquery.json according to the package manifestspecification. Use an online JSON verifier such as JSONlint to make sure the file is valid. You are now ready to publish your plugin!

Publishing a Version

After the service hook is setup and your manifest has been added,publishing your plugin is as simple as tagging the version in git and pushingthe tag to GitHub. The service hook will notify the plugins site that anew tag is available and the plugins site will take care of the rest!

$ git tag 0.1.0
$ git push origin --tags

The name of the tag must be a valid semver value, butmay contain an optional v prefix. The tag name must also match theversion listed in the manifest file. So, if the version field in the manifestis "0.1.1" the tag should be either "0.1.1" or "v0.1.1". If the manifest fileis valid, the version will be automatically added to the plugins site.

The registry does not support re-processing tags that it has already seen.Therefore, we strongly suggest that you do not overwrite old tags. Instead,update the version number tag in the manifest, commit, and create a new tag tofix any errors you've encountered.

For example, you've pushed version v1.7.0 of your plugin, but there is an error detected in the manifest. If you fix the error, delete,re-create, and push another v1.7.0 tag, the registry will not detect it.You will have to create and push v1.7.1.

Troubleshooting

If you have problems with your plugin not publishing you should check the error log for hints on what the problem might be.

If you still encounter trouble getting this process to work with your plugin, pleasejoin the IRC channel #jquery-content on freenode. If you can't seem to connect with someonein the IRC channel, please feel free to email us at plugins@jquery.com.

How long should the process take

When everything works, this process is pretty close to instant. There arecaches in place, etc, but in general, if you haven't seen your plugin getupdated on the site within 5 minutes, there is a good chance something wentwrong. Going into your Web Hooks settings and hitting the "Test Hook" button(once) may help if you recently pushed a new tag.