-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the maven-lombok-template project! This repository serves as a powerful starting point for building Java projects using Maven and that require the usage of Lombok. It's an extension of the Maven Java Template and it comes pre-configured with essential dependencies, plugins, and CI/CD pipelines, with Lombok support included, to help you get started quickly and efficiently.
Whether you're building a small library or a large-scale application, this template is designed to be flexible and customizable, making it suitable for a wide range of Java projects. The project is actively maintained and open to contributions from the community, so your feedback and improvements are always welcome!
- Pre-configured Dependencies: Includes essential libraries like Lombok, Checker Framework, Mockito, and JUnit for testing and development.
- Comprehensive Maven Plugins: Pre-configured plugins for Checkstyle, Source, Javadoc, GPG signing, JaCoCo, and more to streamline your build and release process.
-
Branching Strategy: Supports multiple branches (
main,beta,alpha,dev) to manage different stages of development and release cycles. - Automated CI/CD Pipelines: Integrated workflows for code style checks, build and test automation across multiple platforms, static code analysis, and automated releases to Maven Central.
- Semantic Versioning: The release process is automated using semantic-release and semantic-release-action, ensuring consistent version management and publishing.
To quickly get up and running with maven-lombok-template, check out the Getting Started guide. It covers everything from cloning the repository to setting up your environment and building the project.
The wiki is organized to provide you with all the information needed to make the most out of this template. Here's a quick overview of what you can find:
- Additional Resources: Links to external resources that may be useful for your development process.
- Architecture: An in-depth look at the structure of the project and how the different components fit together.
- Frequently Asked Questions: Frequently asked questions to help you troubleshoot common issues.
- Getting Started: Step-by-step instructions to help you set up and configure your project.
- Licenses and Credits: Information about the licenses of the project and acknowledgments of the tools and libraries used.
- Troubleshooting: Information on solving issues that may arise when using the maven-lombok-template.
- Usage: Details on how to use the various features and configurations available in the template.
For detailed API documentation, visit our Javadoc page. This resource provides comprehensive information about all classes, methods, and interfaces in the project.
We encourage you to contribute to the maven-lombok-template project! Whether it's reporting bugs, suggesting new features, or improving documentation, your contributions are highly valued. Please refer to the contribution guidelines for more details on how to get involved.
If you have any questions, issues, or suggestions, feel free to start a discussion or open an issue on the repository.
Thank you for using maven-lombok-template. We hope this template helps you kickstart your Java projects with ease!