prepare.adoc

layout	title	references
developer	Preparing for Plugin Development	url title https://adoptium.net/ Eclipse Temurin Java url title https://maven.apache.org Apache Maven website

Table of Contents

• Download and install a JDK
• Setting up a productive environment with your IDE
  • IntelliJ IDEA
  • NetBeans
  • Eclipse
• Next step
• Troubleshooting

• Step 1: Preparing for Plugin Development

• Step 2: Create a Plugin

• Step 3: Build and Run the Plugin

• Step 4: Extend the Plugin

Download and install a JDK

Jenkins is based on Java, so to build Jenkins plugins you need to install a Java Development Kit (JDK). Java 17 is the version we recommend to users, so that’s what we’re using in this tutorial.

You can download and install Java 17 from the Eclipse Temurin website.

Note	Many Linux distributions provide packages for Java for an easier install and upgrade experience. Consult your distribution’s documentation for details. To check if you have Java already installed, run java -version on a command prompt.

doc/developer/tutorial-improve/_install-apache-maven.adoc

To verify that Maven is installed, run the following command:

mvn -version

This command prints some diagnostic output, including the versions of Java and Maven, and which Java installation was found by Maven. It should indicate a 17 version of Java, and list the path to where Java is located. If you don’t see this information, see Troubleshooting.

Setting up a productive environment with your IDE

IntelliJ IDEA

IntelliJ users just need to open the project and all should work out of the box.

You are advised to use the IntelliJ IDEA plugin for Jenkins Development, features it provides can be found in its documentation.

You can create a new plugin using one of the Jenkins plugin archetypes. Create a new Maven project using Create from archetype and Add an Archetype. Select the GroupId and ArtifactId as above, and choose RELEASE as version. On the next screen, select io.jenkins.plugins as groupID and choose an artifactId (Project name) and Version to your liking. This will automatically create a maven project based on the specified artifact (for example, empty-plugin).

NetBeans

NetBeans users can use the IDE’s Maven support to open the project directly.

As you navigate through the code, you can tell NetBeans to attach source code JAR files by clicking the "Attach" button that appears in the top of the main content window. This allows you to read the Jenkins core source code as you develop plugins. (Or just select Download Sources on the Dependencies node.)

You are advised to use the NetBeans plugin for Jenkins/Stapler development. This offers many Jenkins-specific features. Most visibly, create a new plugin using New Project » Maven » Jenkins Plugin, and use Run project to test it.

Eclipse

Open the project as an existing Maven Project.

Next step

Create and build your first Jenkins plugin.

Troubleshooting

Note	Anything not working for you? Ask for help on our community forum community.jenkins.io or on the jenkinsci-dev mailing list.