Skip to content

Commit

Permalink
Add documentation about the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
Maciej Szlosarczyk committed Jul 15, 2019
1 parent 0eb7caa commit f659a1f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,22 @@ $ rebar3 tar # Creates an archive that can be shipped to another machine
$ rebar3 as prod release tar # Combines the steps above into single one, uses production profile.
```

### Creating Releases

The application is configured to automatically create releases based on git tags. After you develop
a new functionality, you can create a tag with incremental release:

$ git tag -a v0.1.10 -m "update tcp handler."

After that, you can run the same relx command to create a tarball with new release:

```sh
$ rebar3 as prod release tar
# [Creating the release...]
===> tarball /opt/erlang/epp_proxy/_build/prod/rel/epp_proxy/epp_proxy-0.1.10+build.1.ref0eb7caa.tar.gz
successfully created!
```

Configuration
-----
Configuration for the application tries to emulate the mod_epp configuration as close as possible
Expand Down

0 comments on commit f659a1f

Please sign in to comment.