diff options
| author | Nikolay Tatarinov <5min4eq.unity@gmail.com> | 2018-03-28 01:33:11 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-28 01:33:11 +0300 |
| commit | 83aeb8976d90ad1637243953a9af37e6d4206c52 (patch) | |
| tree | 346e52db0d80c7fb7bdab8013acb38ef8be55fbb /integration/test/resources/play-json/README.md | |
| parent | a796f0a1381632560b6251a93466957319065966 (diff) | |
| download | mill-83aeb8976d90ad1637243953a9af37e6d4206c52.tar.gz mill-83aeb8976d90ad1637243953a9af37e6d4206c52.tar.bz2 mill-83aeb8976d90ad1637243953a9af37e6d4206c52.zip | |
WIP: Play json build (#182)
* play json build
* build progress
* add check task
* try to make play json js build
* scalariform and mima plugins in separate files. check mima
* better error message for mima compatibility check
* fix scala 2.10 compilation
* license headers support
* add jmh support
* fix reformat on compile; fix code validation; extract base module
* remove scala 2.13 from cross versions
* include play-json in integration tests
* add example .travis.yml
* bring back scala 2.13 support
* make reformat target, not command
* add release task
* update mill version in travis.yml
* update release script
* update release process
* add README.md for play json build
Diffstat (limited to 'integration/test/resources/play-json/README.md')
| -rw-r--r-- | integration/test/resources/play-json/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/integration/test/resources/play-json/README.md b/integration/test/resources/play-json/README.md new file mode 100644 index 00000000..d71acae9 --- /dev/null +++ b/integration/test/resources/play-json/README.md @@ -0,0 +1,30 @@ +## Play JSON build + +This is a port of sbt build for [Play JSON](https://github.com/playframework/play-json) library. It has roughly the same features as sbt version, for instance it cross-builds Play JSON under 4 major scala versions both js and JVM. It cam compile sources, run tests, publish artifacts to Sonatype, run benchmarks, reformat code, add license headers, use mima to diagnose binary compatibility issues. + +The main build file is [build.sc](/build.sc), other `.sc` files in root directory provide additional "plugin"-like features. + +### Example commands + +Compile play json for JVM on scala 2.12.4: +```bash +mill playJsonJvm[2.12.4].compile +``` + +Run test on all modules: +```bash +mill __.test +``` + +Run benchmarks on scala 2.12.4: +```bash +mill benchmarks[2.12.4].runJmh +``` + +### CI + +Example CI configuration is in [.travis.yml](/.travis.yml) . It does the same thing as [original one](https://github.com/playframework/play-json/blob/master/.travis.yml) . You can check status of Play JSON built with this `.travis.yml` file [here](travis-ci.org/rockjam/play-json) + +### Release + +To make release run `./release.sh`. Don't forget to export `SONATYPE_CREDENTIALS` and `GPG_PASSPHRASE` env variables. |