This is a quick start template file[Example]. Please describe your stuff.
This file is symbolic linked from the REAME.md
.
This project requires Java SE 8 to build. Please don’t forget installing and using it for building. This is intentional decision to make the testing compatible for as many product as possible.
Also, you need to install mvn
and graphviz
.
To install them, please refer to the following URLs.
Or you can perhaps just do {brew,sudo apt,sudo yum} install {maven,graphviz}
.
$ mvn clean compile
This just compiles your production codes.
$ mvn clean compile test
This compiles your production and test codes and then executes the tests.
$ mvn clean package site
Generates the site under target/site
in the following structure.
target/ site/ index.html - The top page. apidocs/ - JavaDoc jacoco/ - JaCoCo report (code coverage) pit-reports/ - PIT report (mutation coverage)
Note that .adoc
files under the src/site/asciidoc
are rendered into .html
files and placed in this directory.
The mutation testing is configured to cover only small amount of classes to save build time. To configure the coverage, refer to [mutationTesting].
$ mvn clean package site-deply
This generates the documentation and reports and push them to gh-pages
branch of your repository.
The documentation will be available as the repository’s "gh-pages" site.
$ mvn clean compile test org.pitest:pitest-maven:mutationCoverage
By default, the pom.xml
is configured to exercise the mutation testing over small number of classes so that you customize the intended coverage.
Under the plugin configuration for org.pitest:pitest-maven
, you can find a following element.
pom.xml
configuration for org.pitest:pitest-maven
plugin <targetClasses>
<param>com.github.dakusui.java8.template.*</param>
</targetClasses>
To limit the classes to be executed, you can modify it like following.
pom.xml
configuration for org.pitest:pitest-maven
plugin <targetClasses>
<param>com.github.dakusui.java8.template.selected_package.*</param>
</targetClasses>
After a successful execution, it generates a pitest report under a directory target/pit-reports/{yyyyMMddHHmmss}
.
$ mvn clean javadoc:javadoc
This generates JavaDoc under target/site/apidocs
.
Useful for writing/improving your JavaDoc.
Copyright 2022 Hiroshi Ukai.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
Wikipedia article on "Hello, World", https://en.wikipedia.org/wiki/Hello_World