https://github.com/erlware/relx

Sane, simple release creation for Erlang
https://github.com/erlware/relx

Last synced: 2 months ago
JSON representation

Sane, simple release creation for Erlang

• Host: GitHub
• URL: https://github.com/erlware/relx
• Owner: erlware
• License: apache-2.0
• Created: 2013-05-07T00:09:13.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T13:11:56.000Z (5 months ago)
• Last Synced: 2024-10-29T08:41:33.944Z (2 months ago)
• Language: Erlang
• Homepage: http://erlware.github.io/relx
• Size: 6.11 MB
• Stars: 697
• Watchers: 42
• Forks: 232
• Open Issues: 73
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• freaking_awesome_elixir - Erlang - A release assembler for Erlang. (Build Tools)
• fucking-awesome-elixir - relx - A release assembler for Erlang. (Build Tools)
• awesome-erlang - relx - A release assembler for Erlang. (Release Management)
• awesome-elixir - relx - A release assembler for Erlang. (Build Tools)

README

        
![](https://github.com/erlware/relx/workflows/Common%20Test/badge.svg)

![Cirrus CI - Task and Script Build Status](https://img.shields.io/cirrus/github/erlware/relx?label=OSX%20Tests)

Relx

=======

Relx is a library that assembles Erlang/OTP releases. Given a release

specification and a list of directories in which to search for OTP

applications it will generate a release output.

It is generally used through the Erlang/OTP build tool

[rebar3](https://www.rebar3.org/) which provides a cli interface.

Documentation

-----------

`relx` is a library used by [rebar3](https://www.rebar3.org/). Documentation on

using `rebar3` for building releases with `relx` can be found on

[rebar3.org](https://rebar3.org/docs/deployment/releases/).

Also see [Adopting Erlang's Releases

chapter](https://adoptingerlang.org/docs/production/releases/). 

Building and Testing

--------

Common Test suites can be run with `rebar3`:

``` shell

$ rebar3 compile

$ rebar3 ct

```

Tests for the start scripts that are generated by `relx` are tested with

[shelltestrunner](https://github.com/simonmichael/shelltestrunner/).

The script `shelltests/run_tests.sh` will clone `rebar3` main and build it

with the current `relx` as a checkout dependency and then run the tests using

that `rebar3` escript:

``` shell

$ shelltests/run_tests.sh

```