Plugin source code is hosted on GitHub. New feature proposals and bug fix proposals should be submitted as GitHub pull requests. Your pull request will be evaluated by the Jenkins job.
Before submitting your change, please assure that you've added tests that verify the change.
The plugin build process is described in detail in the plugin development chapter of the Jenkins developer guide.
A development copy of the plugin can be run locally with the command:
mvn hpi:run
When submitting a pull request, please refer to the plugin testing guidance in the Jenkins developer guide.
Source code and pom file formatting is maintained by the spotless maven plugin.
Before submitting a pull request, confirm the formatting is correct with:
mvn spotless:apply
Please don't introduce new spotbugs output.
mvn spotbugs:checkanalyzes the project using Spotbugsmvn spotbugs:guidisplays the spotbugs report using GUI
Code coverage reporting is available as a maven target. Please try to improve code coverage with tests when you submit pull requests.
mvn -P enable-jacoco clean install jacoco:reportreports code coverage
The code coverage report shows methods and lines executed.
The following commands will open the index.html file in the browser.
- Windows -
start target\site\jacoco\index.html - Linux -
xdg-open target/site/jacoco/index.html - Gitpod -
cd target/site/jacoco && python -m http.server 8000
The file will have a list of package names. Click on them to find a list of class names.
The lines of the code will be covered in three different colors, red, green, and orange. Red lines are not covered in the tests. Green lines are covered with tests.
Report issues in the Jenkins issue tracker. Please follow the guidelines in "How to Report an Issue" when reporting issues.