Git SCM plugin for Jenkins

Git software configuration management for Jenkins.

• see Jenkins Wiki for feature descriptions
• use Jenkins JIRA to report issues or request features

Requirements

• Jenkins 2.121.1 or newer

Development

Branches

The master branch is the primary development branch.

Branches using name pattern stable-{VERSION} are development branches for changes from a base release VERSION. For example stable-3.x is the branch used to release fixes for plugin version 3.x.

Building the Plugin

To build the plugin you will need

• Maven version 3.5.4 or newer
• Java Development Kit (JDK) version 8

Run the following command to build the plugin

mvn package

Contributing to the Plugin

Plugin source code is hosted on GitHub. New feature proposals and bug fix proposals should be submitted as pull requests. Fork the repository. Make the desired changes in your forked copy. Submit a pull request to the master branch. Your pull request will be evaluated by the Jenkins job.

Before submitting your pull request, please add tests which verify your change. There have been many developers involved in the git plugin and there are many users who depend on the git plugin. Tests help us assure that we're delivering a reliable plugin and that we've communicated our intent to other developers in a way that they can detect when they run tests.

Code coverage reporting is available as a maven target and is actively monitored. Please improve code coverage with the tests you submit. Code coverage reporting is written to target/site/jacoco/ by the maven command

mvn -P enable-jacoco clean install jacoco:report

Before submitting your change, review the SpotBugs output to assure that you haven't introduced new warnings.

mvn spotbugs:check

To Do

• Fix bugs
• Improve code coverage
• Improve javadoc