Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.81 KB

README.md

File metadata and controls

73 lines (47 loc) · 2.81 KB

codecov

Codecov Java Project Documentation

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.

Table of Contents

Getting Started

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.

Prerequisites

  • JDK 11 or later
  • Maven 3.6 or later

Project Structure

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.

Reference Documentation

For further information and reference, consider the following resources:

Building and Running

To build the project, navigate to the root directory and run:

./mvnw clean install

Code Coverage with JaCoCo and Codecov

This 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.

Generating Coverage Reports with JaCoCo

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-package

After 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:

CodeCov Dashboard