Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
priv/templates/ | H | 03-May-2022 | - | 2,938 | 2,276 | |
src/ | H | 03-May-2022 | - | 4,397 | 3,461 | |
LICENSE.md | H A D | 01-Jan-2000 | 10.1 KiB | 195 | 166 | |
README.md | H A D | 01-Jan-2000 | 1.3 KiB | 45 | 31 | |
rebar.config | H A D | 01-Jan-2000 | 2.5 KiB | 63 | 52 | |
rebar.lock | H A D | 01-Jan-2000 | 293 | 9 | 8 |
README.md
1![](https://github.com/erlware/relx/workflows/Common%20Test/badge.svg) 2![Cirrus CI - Task and Script Build Status](https://img.shields.io/cirrus/github/erlware/relx?label=OSX%20Tests) 3 4Relx 5======= 6 7Relx is a library that assembles Erlang/OTP releases. Given a release 8specification and a list of directories in which to search for OTP 9applications it will generate a release output. 10 11It is generally used through the Erlang/OTP build tool 12[rebar3](https://www.rebar3.org/) which provides a cli interface. 13 14Documentation 15----------- 16 17`relx` is a library used by [rebar3](https://www.rebar3.org/). Documentation on 18using `rebar3` for building releases with `relx` can be found on 19[rebar3.org](https://rebar3.org/docs/deployment/releases/). 20 21Also see [Adopting Erlang's Releases 22chapter](https://adoptingerlang.org/docs/production/releases/). 23 24 25Building and Testing 26-------- 27 28Common Test suites can be run with `rebar3`: 29 30``` shell 31$ rebar3 compile 32$ rebar3 ct 33``` 34 35Tests for the start scripts that are generated by `relx` are tested with 36[shelltestrunner](https://github.com/simonmichael/shelltestrunner/). 37 38The script `shelltests/run_tests.sh` will clone `rebar3` master and build it 39with the current `relx` as a checkout dependency and then run the tests using 40that `rebar3` escript: 41 42``` shell 43$ shelltests/run_tests.sh 44``` 45