README.md

template-java-gradle

Template for single-module Java projects at Nelkinda.

Features

• Makefile as wrapper to make standard workflows as well as pipeline reproduction easier to access.
• Extensive static code analysis to ensure the quality of certain aspects of structure using CheckStyle, PMD, and SonarLint.
• Extensive dynamic code analysis to ensure the quality of behavior using JUnit 5, Cucumber, JaCoCo, and Pitest.
• Tracking of analysis reports using SonarQube.
• Preconfigured CI/CD pipelines for Bitbucket, GitHub, GitLab, and Travis.
• Available on: Bitbucket, GitHub, GitLab.

How to use

GitHub Template

• Create a new repository based on this template: https://github.com/nelkinda-templates/template-java-gradle/generate
• Open the repository in your favorite IDE, for example IntelliJ IDEA.
• Look for all the TODO comments and solve them to replace placeholders, including those in this file.

Reports

The reports are available locally, after running a build using make.

• Checkstyle Report Main
• Checkstyle Report Test
• PMD Report Main
• PMD Report Test
• SonarLint Report Main
• SonarLint Report Test
• Test Report
• Jacoco Test Coverage Report
• PiTest Mutation Test Report