Tailormap persistence provides the persistence API for Tailormap admin and Tailormap API.
Basic procedure:
- do your thing, if possible use
aospstyling - run
mvn clean installto make sure all required formatting is applied and all tests pass - commit and push your branch to create a pull request
- wait for code review to pass, possibly amend your PR and merge your PR
Make sure you have useful commit messages, any PR with WIP commits will need
to be squashed before merge.
see also QA
- You can skip CI execution1 by specifying
[skip ci]as part of your commit. - You can use
mvn -U org.codehaus.mojo:versions-maven-plugin:display-plugin-updatesto search for plugin updates - You can use
mvn -U org.codehaus.mojo:versions-maven-plugin:display-dependency-updatesto search for dependency updates
Some Maven profiles are defined:
- release
- Release specific configuration
- Activated automagically
- developing
- Sets specific properties for use in the IDE such as disabling docker build and QA
- Activated using the flag
-Pdevelopingor checking the option in your IDE
- qa-skip
- Will skip any "QA" Maven plugins defined with a defined
skipelement - Activated using flag
-DskipQA=true
- Will skip any "QA" Maven plugins defined with a defined
Some quick points of attention:
- AOSP formatting is enforced
- PMD checks are enforced
- The ErrorProne compiler is used
- A current release of Maven is required
- Java 11
- jUnit 4 is forbidden
- code is reviewed before merge to the main branch
- Javadoc must be valid
Use the regular Maven release cycle of mvn release: prepare followed by mvn release:perform. Please make sure that
you use tailormap-persistence-<VERSION> as a tag so that the release notes are automatically created.
For example:
mvn clean release:prepare -DreleaseVersion=0.1 -Dtag=tailormap-persistence-0.1 -DdevelopmentVersion=0.2-SNAPSHOT -T1
mvn release:perform -T1