Add probes to "Plugin Health Score"

Project goal: First iteration of the tool provided a limited set of probes. To improve the effectiveness of the scoring system, more probes are needed.

Skills to study/improve: Java, Data extraction from GitHub repositories, Data analysis applied to data representation



Keeping a plugin current with the ongoing development of Jenkins is key for a smooth operation. Keeping it current can require user interface improvements, dependency updates, and more.

“Plugin Health Score” was a successful GSoC 2022 project. It laid the principles, the framework, and the automation for this important feature. For reference, the code product of the original 2022 GSoc project can be viewed on GitHub.

Measurements of the plugin’s "health" helps Jenkins maintainers as they decide how to invest their development time. With such a system, items that need to be maintained, improved, or adapted are identified.
For example, having Release Drafter correctly configured and Pull Request Labeling in place is a recognized good practice. It reduces the effort to provide a changelog with each release.
Another example: having Dependabot properly configured will reduce the dependency update effort by automatically submitting update pull requests.

Measurements of the plugin’s "health" will help users to decide if they should install and use a plugin. Plugins with a lower health score may be less likely to meet the user’s reliability needs. It is similar to a badly maintained garden that will make harvesting difficult and not yield good vegetables or fruits.

The plugin health score already provides a few probes to measure the health of a plugin. Now it’s your turn to implement more probes.

A “Plugin Health Score Probe” will be executed on all the plugins to verify the status or measure a given health indicator. Some can be quite simple, but others need creativity and skills. The more probes we have, the better the health score quality and its representativity. Bottom line: we need more probes…

Quick Start

A presentation of the "Plugin Health Score" project was made during the 10-Feb-2022 GSoC Office Hour.

A presentation of the status of the "Plugin Health Score" project at the end of GSoC 2022 was made during the 05-Oct-2022 GSoC Final Edition.

Some simple probe ideas

  • Comparing the existing parent pom to the latest one?

  • Comparing the base Jenkins version to the latest one?

  • See if spotbugs has been configured to catch most of the bugs

  • Has a contributing guide

  • Has enabled incremental builds

  • Has replaced JSR-305 Nonnull and CheckForNull annotations with spotbugs annotations

Existing probes are listed at Plugin Health Scoring :: Probes

Skills to Study and Improve

  • Java

  • Data extraction from GitHub repositories

  • Data analysis applied to data representation

Project Difficulty Level

Beginner to Intermediate

Project Size

175 hours

Expected outcomes

New probes to help improve the plugin health score.

Details to be clarified interactively, together with the mentors, during the Contributor Application drafting phase.

Newbie Friendly Issues

For some newbie friendly issues, please refer to the issue tracker on GitHub. Look out for the friendly label for some issues that can be served as an introduction to the project.

Potential Mentors

Project Links

Organization Links

> Go back to other GSoC 2023 project ideas