Welcome to the Codecov Java Project documentation. This document aims to provide you with all the necessary information to get started with the project, understand its structure, and contribute to its development.
This project utilizes Maven for dependency management and build automation. It is structured according to standard Maven project conventions and includes integration with Spring Boot for rapid application development.
- JDK 11 or later
- Maven 3.6 or later
The project follows the standard Maven project structure:
src/main/java/: Application source code.src/main/resources/: Application resources (e.g., properties files).src/test/java/: Test source code.target/: Generated artifacts and compiled classes.
For further information and reference, consider the following resources:
To build the project, navigate to the root directory and run:
./mvnw clean installThis project uses JaCoCo to generate code coverage reports during the build process and integrates with Codecov to track code coverage over time, ensuring high-quality code standards.
JaCoCo is configured to run with Maven's test phase, automatically generating coverage reports in the target/site/jacoco/ directory. To generate a JaCoCo coverage report, run:
./mvnw clean test./mvnw prepare-packageAfter running tests, you can find the JaCoCo coverage report in target/site/jacoco/index.html.
To view the project's code coverage reports and track coverage changes over time, visit the project's Codecov page: