The RxMicro Framework
A modern, JVM-based, full stack framework designed to develop distributed reactive applications that use a microservice architecture.
Requirements
Verified On
Supported Features
Status of all supported features is available at the Features Table
Latest Releases
Documentation
Contributing
Contributions to the RxMicro framework are both welcomed and appreciated. For specific guidelines regarding contributions, please see CONTRIBUTING.md.
Check Lists
See CHECK_LISTS.md.
Code Quality
Spotbugs (https://spotbugs.github.io/)
(Standard spotbugs profile with excludes)
Verify via spotbugs
:
mvn --fail-at-end -DskipTests -P spotbugs clean verify
If build failed find Total bugs
phrase at the console output...
mvn --fail-at-end -DskipTests -P spotbugs \
-Dspotbugs-maven-plugin.failOnError=false \
clean verify site site:stage
PMD (https://pmd.github.io/)
(Custom pmd profile with exclude-pmd and exclude-cpd)
Verify via pmd
:
mvn --fail-at-end -DskipTests -P pmd clean verify
If build failed find PMD Failure
phrase at the console output...
mvn --fail-at-end -DskipTests -P pmd \
-Dmaven-pmd-plugin.failOnViolation=false \
clean verify site site:stage
Checkstyle (https://checkstyle.sourceforge.io/)
- (Custom common checkstyle profile with common-suppressions for all classes)
- (Custom public checkstyle profile with public-api-suppressions for public classes)
Verify via checkstyle
:
mvn --fail-at-end -DskipTests -P checkstyle clean verify
If build failed find reported by Checkstyle
phrase at the console output...
mvn --fail-at-end -DskipTests -P checkstyle \
-Dmaven-checkstyle-plugin.failOnViolation=false \
clean verify site site:stage
All tools
Verify via spotbugs
, pmd
, checkstyle
:
mvn --fail-at-end -DskipTests -P spotbugs,pmd,checkstyle clean verify
If build failed find Total bugs
, PMD Failure
, reported by Checkstyle
phrase at the console output...
mvn --fail-at-end -DskipTests -P spotbugs,pmd,checkstyle \
-Dspotbugs-maven-plugin.failOnError=false \
-Dmaven-pmd-plugin.failOnViolation=false \
-Dmaven-checkstyle-plugin.failOnViolation=false \
clean verify site site:stage
Publish to Maven Central
https://central.sonatype.org/pages/apache-maven.html
https://oss.sonatype.org/#stagingRepositories