A Maven Archetype for generating new Spring web service projects, fully prepared to take advantage of a CI process.
While it can be prepared for any CI service, it is prepared for Github Workflow. Acquiring the code from a Github repository and publishing into OSS Sonatype or Github packages.
After running all the tests artifacts will be published into this repository, but the new project will be able to generate and publish also a Maven site, which, thanks to the Docs Maven Skin, will show documentation and useful reports from Checkstyle, SpotBugs and similar tools.
The Archetype will do little more than take care of configuration, setting up the POM and the Maven project is most of its job, and so it will include few files not related to this. Some useful things such as a readme, a gitignore and a license files are included, but the initial code will consists just of a few placeholder classes.
- Fully configured POM, extending from bernardomg's Base POM, including features such as build validation, changes report or manifest configuration.
- Prepared for continuous integration with Github, Github Workflow and both OSS Sonatype and Github packages. Making a distinction between releases and development versions.
- Prepared for unit and integration tests suites. Created with JUnit and ready to be run with Surefire and Failsafe.
- A Maven site, using the Docs Maven Skin, for sharing the project's documentation along the Javadocs and various reports which range from code quality to changes log.
- Includes basic files such as readme, gitignore and license.
A sample project shows what this Archetype is capable of creating.
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
mvn verify site
The verify phase is required, otherwise some of the reports won't be generated.
The application is coded in Java, using Maven to manage the project.
It is a Maven Archetype, and can be used through command line or an IDE as long as it is included in the local repository.
By default the project will be set for JDK 11. If this needs to be changed, for example to make use of JDK 17, the java.version property has to be overriden:
<properties>
<java.version>17</java.version>
<\properties>The archetype can be installed with the following Maven coordinates:
Group ID: com.bernardomg.maven.archetypes
Artifact ID: spring-web-service-maven-archetype
Version: (Check POM or badges)
For example, to use it through command line type the following:
mvn archetype:generate -DarchetypeGroupId=com.bernardomg.maven.archetypes -DarchetypeArtifactId=spring-web-service-maven-archetype -DarchetypeVersion=[version]
If using an IDE check its documentation to find out how to use Maven Archetypes, and how to add these to the local repository.
As an alternative, it is always possible to download the project from Github, and then install it using the usual Maven command:
mvn install
The archetype plugin comes ready to run integration tests for the archetype by using the usual Maven command:
mvn verify
Check the archetype testing goal for more info.
If using Eclipse the tests may not run, due to an incompatibility with the Maven Invoker library. It is recommender running the tests through command line.
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
The project has been released under the MIT License.