Developer Guide¶
Uses of this library¶
- This library is for use by security verification service to verify that users have the rights to use a solution for commercial models.
- This library is for use by portal back end to create new rights to use a solution for a user or for entire site.
- This library provides license.json sementic validation to ensure consistent models.
How to build locally¶
- to build and install
`
mvn clean install
`
This will require settings setup for nexus for acumos. See CI / CD instructions.
- To run license check and update headers
- Other goals:
Check license headers do this before review.
`
mvn license:check-file-header
`
To update license headers automatically. Note that if you have a header it will not update the copyright or description.
`
mvn license:update-file-header
`
- To check java docs are working
`
mvn javadoc:javadoc
`
You can view javadocs in the path provided in console
- Fixing java docs
`
mvn javadoc:fix -DfixTags="param,return,throws,link"
`
- Unit test coverage should be above 40%
Check html page under here
`
license-manager-client-library/target/site/jacoco/org.acumos.licensemanager.client.model/index.source.html
`
- Check style
`
mvn checkstyle:check
`