Update minimum Jenkins version

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

Require a newer minimum Jenkins version

Jenkins plugins declare a minimum supported Jenkins version. The minimum Jenkins version is a good way for plugin developers to indicate the range of Jenkins versions they are willing to support and test. See the developer documentation for the recommended minimum Jenkins version.

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

Update minimum required Jenkins version

Update the minimum required Jenkins version by setting a jenkins.version value in the properties section of the pom.xml file:

   <properties>
     <jenkins.version>2.440.3</jenkins.version>
   </properties>

If the plugin is already using the plugin bill of materials, then the bill of materials also needs to be updated with the matching artifactId for the minimum required Jenkins version. The version may also need an upgrade see the developer documentation.

The git diff might look like this:

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.jenkins.tools.bom</groupId>
-        <artifactId>bom-2.361.x</artifactId>
+        <artifactId>bom-2.452.x</artifactId>
-        <version>2102.v854b_fec19c92</version>
+        <version>3080.vfa_b_e4a_a_39b_44</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

Compile the plugin

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

mvn clean verify

Create a pull request

Commit that change:

git add {modified-files}
git commit -m "{task-description}"

Push the change to GitHub:

git push origin --set-upstream {task-identifier}

Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote:
remote: Create a pull request for '{task-identifier}' on GitHub by visiting:
remote: https://github.com/user/your-plugin/pull/new/{task-identifier}
remote:
To github.com:user/your-plugin.git
 * [new branch]      {task-identifier} -> {task-identifier}
Branch '{task-identifier}' tracking remote branch '{task-identifier}'.

Notice that the output of the command includes the URL, which can be used to open a pull request. Copy that URL in your web browser and submit a pull request.