Alexander Afanasyev | 8e9330f | 2016-01-25 19:13:40 -0800 | [diff] [blame] | 1 | # Developer Notes |
| 2 | |
| 3 | ## Compile |
| 4 | |
| 5 | To compile: |
| 6 | |
| 7 | ./gradlew assemble |
| 8 | |
| 9 | Note: when compiling on Windows, replace `./gradlew` with `gradlew` or `gradlew.bat`. |
| 10 | |
| 11 | To build documentation: |
| 12 | |
| 13 | ./gradlew javadoc |
| 14 | |
| 15 | To build all artifacts and publish to a local maven repository: |
| 16 | |
| 17 | ./gradlew install |
| 18 | |
| 19 | To publish to maven repository `signing.keyId`, `signing.password`, `signing.secretKeyRingFile`, |
| 20 | `ossrhUsername`, and `ossrhPassword` variables need to be defined in project-specific or |
| 21 | user-specific `gradle.properties` file. After the variables defined, run the following command |
| 22 | to build, sign, and upload archives to maven: |
| 23 | |
| 24 | ./gradlew uploadArchives |
| 25 | |
| 26 | To get list of other targets, use `./gradlew tasks`. |
| 27 | |
| 28 | ### Unit Tests |
| 29 | |
| 30 | To run unit tests: |
| 31 | |
| 32 | ./gradlew test |
| 33 | |
| 34 | To run a specific test or test case, use `--tests=<test-name>[.<test-case>]` command-line option. For example, |
| 35 | |
| 36 | ./gradlew test --tests *MockFaceTest |
| 37 | ./gradlew test --tests *MockFaceTest.ExpressInterest |