2018-05-20 16:49:41 +00:00
|
|
|
# Development Instructions
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
./scripts/lein-modules do clean, install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Running tests
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
./scripts/test.sh clj
|
|
|
|
|
./scripts/test.sh cljs
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
The documentation is built with [gitbook](https://toolchain.gitbook.com). To preview your changes locally:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install -g gitbook-cli
|
|
|
|
|
gitbook install
|
|
|
|
|
gitbook serve
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## To bump up version:
|
|
|
|
|
|
2019-03-14 07:50:21 +00:00
|
|
|
We use [Break Versioning][breakver]. Remember our promise: patch-level bumps never include breaking changes!
|
|
|
|
|
|
|
|
|
|
[breakver]: https://github.com/ptaoussanis/encore/blob/master/BREAK-VERSIONING.md
|
|
|
|
|
|
2018-05-20 16:49:41 +00:00
|
|
|
```bash
|
|
|
|
|
# new version
|
|
|
|
|
./scripts/set-version "1.0.0"
|
|
|
|
|
./scripts/lein-modules install
|
|
|
|
|
|
|
|
|
|
# works
|
|
|
|
|
lein test
|
|
|
|
|
|
|
|
|
|
# deploy to clojars
|
|
|
|
|
./scripts/lein-modules do clean, deploy clojars
|
|
|
|
|
```
|
