We encourage plugin developers to host the plugins in the Jenkins community repositories on Github.
In order to host a plugin in the Jenkins plugin Update Centre, you must:
Having completed the prerequisites above, join the developers' mailing list and send a message to tell us:
You'll get commit access to the repository under https://github.com/jenkinsci.
Once you have a Jenkins repository, you can start making the following preparations for your first release.
In some cases you may get an empty repository, rather than a fork, in which case you can import your source code:
We also recommend you look around some other plugin's POM file (such as this) to trim off the redundant things.
For example, usually the <groupId> is removed (groupId for the plugin, not the one in the <parent> section), to use the default which is org.jenkins-ci.plugins. <repositories> and <pluginRepositories> can be removed as well. If you need help, contact the dev list.
The location of your repository must be declared in the POM for plugins hosted in Github, by adding the following fragment:
Each plugin must have its own page on this wiki, as a child of the Plugins page.
This serves as documentation, links to the source code and issue tracker, and makes it easier for people to find your plugin via search engines.
These are the bare minimum requirements for a plugin page. This page will be linked from the Plugins page as well as directly from the Jenkins plugin manager.
Once you have made your first release, you should add changelog information to the page, and document what the plugin does, and how it is configured.
Please check out some good examples of how you should lay out your page:
If you wish, you can also manage your documentation in your GitHub repo, so long as there's a clear link from your plugin's wiki page.
Now that you have a wiki page, its URL must be listed in your pom.xml like this:
If you're building your plugin with Gradle, you must set the URL in your build.gradle like so:
Or if you have a plugin written in Ruby, you must edit your .pluginspec file like so:
This ensures that the update centre will list your plugin correctly. If this is missing, or does not point to your Jenkins wiki page, your plugin will not be included in the update centre.
In your POM, make sure to include developer information, such as:
The ID is your jenkins-ci.org account. The name is a human readable display name. This ensures that the update center and related tools are able to properly display the maintainer for your plugin.
Continuous integration builds on DEV@cloud
To have your plugin built on jenkins.ci.cloudbees.com, you do not need to do anything---all Jenkins plugins are automatically built as Maven jobs (clean install -e). All plugin CI broken build results will be mailed to any configured developers in the POM, plus culprits.
The easiest way to publish a plugin is to run the maven release plugin with your jenkins-ci.org account:
If you are using GitHub, make sure that the "origin" remote is pointed to your actual plugin repository.
This will perform all the usual Maven release activity, and it will also post the plugin to the download section. If you run with the -B option, Maven will automatically use all the default values without prompting.
However if your plugin is hosted on GitHub and you have different username and/or password for GitHub and jenkins-ci.org use of the command-line arguments for username/password will result in errors. You will have to start an ssh-agent and import your private key so the release plugin can access the GitHub repository and configure the password for jenkins-ci.org in your ~/.m2/settings.xml as described below.
Instead of listing username/password on the command line, you may also specify these in ~/.m2/settings.xml as follows:
You may also follow these instructions to encrypt the password stored in settings.xml. Once you are done with this run mvn deploy to verify that your credential is correctly recognized by Maven.
Additionally, note that your settings.xml file may need extra configuration for publishing the plugin. See here.
Also consider these tips before making a plugin release.
The released plugin should show up in the update center within eight hours.
You will likely need to add your new release info to the Changelog section of your Jenkins plugin wiki page.
These are some common issues that can occur when releasing a plugin.
Most plugins use org.jenkinsci.plugins.*, but if you'd like to use your own package name, feel free to do so.
Skip to end of metadata Go to start of metadata