About
Building
This project uses maven-toolchains-plugin, so you’ll need to setup toolchains.
Examples for various OS/architectures can be found here
With toolchains configured, run mvn clean install.
When modifying the code beware/be-aware the build will fail if Maven POMs, Java source or Javascript source aren’t formatted according to conventions (Apache Maven’s standards for POMs, my own undocumented formatting for source). To auto-format the lot, simply run mvn -P '!strict,tidy'.
To run PiTest use mvn -P analyse
To run against SonarQube use mvn -P analyse,sonar
Site Generation
Site generation is a bit fiddly, as we’d like to include the offline search functionality but can’t use the maven plugin due to circular dependency (so uses maven-exec and antrun)
mvn -P 'analyse,report,site' clean install site && mvn -P post-site && mvn site:stage
Roadmap
The current early release(s) have just been to provide functionality and test utilities for modules in io.earcam.maven.plugin. Other tiny utilities are in the pipeline.
Generally, lots of improvements and documentation TODO…