Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace JSR-305 annotations with spotbugs annotations #967

Merged
merged 2 commits into from
May 20, 2024

Conversation

MarkEWaite
Copy link
Contributor

Replace JSR-305 annotations with spotbugs annotations

Annotations for Nonnull, CheckForNull, and several others were proposed for Java as part of dormant Java specification request JSR-305. The proposal never became a part of standard Java.

Jenkins plugins should switch from using JSR-305 annotations to use Spotbugs annotations that provide the same semantics.

The mailing list discussion from James Nord describes the affected annotations and why they should be replaced with annotations that are actively maintained.

The "Improve a plugin" tutorial provides instructions to perform this change.

An OpenRewrite recipe is also available and is even better than the tutorial.

Also resolves the 19 spotbugs warnings that are visible on the master branch.

Testing done

Confirmed that automated tests pass on Linux with Java 21.

Submitter checklist

Preview Give feedback

MarkEWaite added 2 commits May 7, 2024 16:00
This exclusion is widely used in Jenkins plugins because public primitives
are often part of the public API of a Java object in Jenkins.

Removes the spotbugs plugin from the pom file because the parent pom
already provides it and provides additional configuration to make spotbugs
even more useful for a Jenkins plugin.

Resolves the 19 spotbugs warnings that are reported on the master branch.
Annotations for Nonnull, CheckForNull, and several others were proposed
for Java as part of dormant Java specification request JSR-305. The
proposal never became a part of standard Java.

Jenkins plugins should switch from using JSR-305 annotations to use
Spotbugs annotations that provide the same semantics.

The [mailing list discussion](https://groups.google.com/g/jenkinsci-dev/c/uE1wwtVi1W0/m/gLxdEJmlBQAJ)
from James Nord describes the affected annotations and why they should
be replaced with annotations that are actively maintained.

The ["Improve a plugin" tutorial](https://www.jenkins.io/doc/developer/tutorial-improve/replace-jsr-305-annotations/)
provides instructions to perform this change.

An [OpenRewrite recipe](https://docs.openrewrite.org/recipes/jenkins/javaxannotationstospotbugs)
is also available and is even better than the tutorial.

Confirmed that automated tests pass on Linux with Java 21.
@res0nance res0nance merged commit b556694 into jenkinsci:master May 20, 2024
16 checks passed
@MarkEWaite MarkEWaite deleted the fix-jsr-305 branch December 24, 2024 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants