Update parent POM

This site is the new docs site currently being tested. For the actual docs in use please go to https://www.jenkins.io/doc.

Use latest parent POM

The Maven project object model ("POM") defines a parent project object model that provides default settings. An update of the parent POM will allow this plugin to compile with recent Java versions. The most recent parent POM files also provide additional static analysis like spotbugs and optional automated source code formatting.

Create a branch

In a local copy of your fork of the plugin repository create a git branch for your work with the command:

git checkout -b {task-identifier} master

Install Apache Maven

Jenkins plugins are built with Apache Maven.

Download Maven from the Apache Maven website. Make sure to download one of the binary archives (with bin in their name).

Many Linux distributions provide packages for Maven for an easier install and upgrade experience. Consult your distribution’s documentation for details. On macOS, the Homebrew package manager offers Maven packages. Make sure a recent version of Maven 3, ideally 3.8.6 or newer, is provided if you decide to go this route.

Next, you will need to extract Maven and take note of its location. When you extract the Maven files, make sure you extract them directly into the target directory. For example, extract the files straight into C:\Program Files (x86)\Maven; do not extract the files to a different location and then copy the files.

Then, add the full path of the bin/ subdirectory extracted (for example, ~/Applications/apache-maven/bin or C:\Program files\Maven\bin) to the PATH variable in your OS. This will let you invoke Maven using mvn.

The rest of the tutorial assumes that Maven is on your PATH environment variable.

Configure Apache Maven

Apache Maven needs to be configured for Jenkins plugin development. The hpi plugin for Apache Maven requires some additional global configurations to function correctly with older Jenkins plugin environments.

Improper configuration settings can cause Maven to report errors or warnings, including failure to download artifacts during the update process. To avoid issues, include the following content in the settings.xml file in your ~/.m2 directory (Windows users will find them in %USERPROFILE%\.m2\settings.xml):

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                              http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <pluginGroups>
    <pluginGroup>org.jenkins-ci.tools</pluginGroup>
  </pluginGroups>
  <profiles>
    <profile>
      <id>jenkins</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <repositories>
        <repository>
          <id>repo.jenkins-ci.org</id>
          <url>https://repo.jenkins-ci.org/public/</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>repo.jenkins-ci.org</id>
          <url>https://repo.jenkins-ci.org/public/</url>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>
</settings>

Compile the plugin

Use Apache Maven to compile the plugin and run its automated tests with the command:

mvn clean verify

When modernizing older plugins, You may need to use Java 8 to compile the plugin initially. Once the parent POM has been updated, you’ll be able to compile and test with recent Java versions.