Usage

The maven-lombok-template repository is designed to be flexible, allowing you to easily adapt it to your project’s needs. Below is a guide on how to use and customize the template.

Customizing Dependencies

The template includes several dependencies by default:

• Lombok: Reduces boilerplate code with annotations.
• Checker Framework: For null checking and other static analysis.
• Mockito: For mocking in unit tests.
• JUnit: The testing framework used in the template.

Feel free to add or remove dependencies in the pom.xml, core/pom.xml or javadoc/pom.xml files as needed.

Customizing Plugins

This template comes with several Maven plugins pre-configured:

• Checkstyle: Enforces code style.
• Source & Javadoc: Generates source and Javadoc archives.
• GPG: Signs the final archives.
• Central Publishing: Automates publishing to Maven Central.
• JaCoCo: Measures code coverage.
• Checker Framework: Enforces null safety and other checks.
• Jar & Assembly: Packages the application.

Modifying Plugin Configurations

You can tweak the configuration of each plugin in the pom.xml, core/pom.xml or javadoc/pom.xml files. Or you can create additional configuration files depending on what you are trying to configure. For example, to adjust the rules enforced by Checkstyle, create a checkstyle.xml configuration file.

Branching Strategy

The repository follows a structured branching strategy:

• main: Stable release branch.
• beta, alpha, dev: Used for pre-releases and testing.

When contributing, make sure to branch off from the correct base branch depending on the type of change or release you are targeting.