spotbugs/spotbugs-archetype

Maven archetype to generate project for SpotBugs plugin

SpotBugs is the spiritual successor of FindBugs, carrying on from the point where it left off with support of its community.

SpotBugs is licensed under the GNU LESSER GENERAL PUBLIC LICENSE.

More information at the official website. A lot of things can still be found at the old FindBugs website.

Build

SpotBugs is built using Gradle. The recommended way to obtain it is to simply run the gradlew (or gradlew.bat) wrapper, which will automatically download and run the correct version as needed (using the settings in gradle/wrapper/gradle-wrapper.properties).

Building SpotBugs requires JDK 21 to run all the tests (using SpotBugs requires JDK 8 or above).

To see a list of build options, run gradle tasks (or gradlew tasks). The build task will perform a full build and test.

To build the SpotBugs plugin for Eclipse, you'll need to create the file eclipsePlugin/local.properties, containing a property eclipseRoot.dir that points to an Eclipse installation's root directory (see .github/workflows/release.yml for an example), then run the build. To prepare Eclipse environment only, run ./gradlew eclipse. See also detailed steps.

Using SpotBugs

SpotBugs can be used standalone and through several integrations, including:

• Ant
• Maven
• Gradle
• Eclipse
• Sonarqube
• IntelliJ IDEA

Questions?

You can contact us using GitHub Discussions.

spotbugs-archetype's Issues

Release v0.2.0 after SpotBugs 3.1.0 release

SpotBugs will release 3.1.0 final soon, then we can release v0.2.0 from this repo.
We also need to update following documents:

• http://spotbugs.readthedocs.io/en/latest/implement-plugin.html
• https://github.com/spotbugs/spotbugs-archetype#how-to-use

Fix GPG sign in PR

#131 moved the GPG sign from Travis to GitHub Actions, but it's not working as expected:
https://github.com/spotbugs/spotbugs-archetype/runs/2562113326

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Deployment to maven failed.

The deployment to maven failed for an unknown reason.

Please check the logs on the CI server to see what happened.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

PR from dependabot cannot run successfully due to lack of GPG passphase

example: https://github.com/spotbugs/spotbugs-archetype/runs/3407947557?check_suite_focus=true#step:6:1880

mvn archetype:generate error

mvn archetype:generate
-DarchetypeArtifactId=spotbugs-archetype
-DarchetypeGroupId=com.github.spotbugs
-DarchetypeVersion=0.2.3

[ERROR] [ERROR] Some problems were encountered while processing the
[ERROR] Unresolveable build extension: Plugin org.sonatype.plugins:nexus-staging-maven-plugin:1.6.8 or one of its dependencies could not be resolved: Failed to collect dependencies at org.sonatype.plugins:nexus-staging-maven-plugin:jar:1.6.8 -> org.sonatype.nexus:nexus-client-core:jar:2.14.3-02 @
[ERROR] Unknown packaging: maven-archetype @ line 8, column 14
@
[ERROR] The build could not read 1 project -> [Help 1]
[ERROR]
[ERROR] The project com.github.spotbugs:spotbugs-archetype:0.2.3-SNAPSHOT (/xxxxxxx/myfindbug/spotbugs-archetype/pom.xml) has 2 errors
[ERROR] Unresolveable build extension: Plugin org.sonatype.plugins:nexus-staging-maven-plugin:1.6.8 or one of its dependencies could not be resolved: Failed to collect dependencies at org.sonatype.plugins:nexus-staging-maven-plugin:jar:1.6.8 -> org.sonatype.nexus:nexus-client-core:jar:2.14.3-02: Failed to read artifact descriptor for org.sonatype.nexus:nexus-client-core:jar:2.14.3-02: Could not transfer artifact org.sonatype.nexus.buildsupport:nexus-buildsupport-commons:pom:2.14.3-02 from/to rso-public-grid (https://repository.sonatype.org/content/groups/sonatype-public-grid/): Remote host closed connection during handshake: SSL peer shut down incorrectly -> [Help 2]
[ERROR] Unknown packaging: maven-archetype @ line 8, column 14
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/ProjectBuildingException
[ERROR] [Help 2] http://cwiki.apache.org/confluence/display/MAVEN/PluginManagerException

i need help!!!

Build a 2.x archetype rather than on old (1.x) Archetype

At the moment, the build issues the following warning:

Building an Old (1.x) Archetype: consider migrating it to current 2.x Archetype.

We should investigate why we get this warning and then make the switch to the 2.x archetype format. (Note that I don’t think we get this warning accidentally, as part of bug ARCHETYPE-483; we use a version of the maven-archetype-plugin where this bug is fixed already.)

archetype command not working for version 0.2.4

Build fails when I use :

mvn archetype:generate \
    -DarchetypeArtifactId=spotbugs-archetype \
    -DarchetypeGroupId=com.github.spotbugs \
    -DarchetypeVersion=0.2.4

You can see it here in this screenshot :

However, if you change the version to 0.2.0 instead of 0.2.4, Like shown in command given below, it works just fine:

mvn archetype:generate \
    -DarchetypeArtifactId=spotbugs-archetype \
    -DarchetypeGroupId=com.github.spotbugs \
    -DarchetypeVersion=0.2.0

Please refer the screenshot given below:

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Deployment to maven failed.

The deployment to maven failed for an unknown reason.

Please check the logs on the CI server to see what happened.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀