Skip to content

Commit d32ad19

Browse files
ericentinJosé Valim
authored andcommitted
Update CHANGELOG.md
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
1 parent 4635631 commit d32ad19

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,24 @@ Finally, if there is a dependency you don't want to include in the application r
9191

9292
We hope this feature provides a more streamlined workflow for developers who are building releases for their Elixir projects.
9393

94+
## Mix install from SCM
95+
96+
Mix v1.4 can now install escripts and archives from both Git and Hex, providing you with even more options for distributing Elixir code.
97+
98+
This makes it possible to distribute CLI applications written in Elixir by publishing a package which builds an escript to Hex. [`ex_doc`](https://hex.pm/packages/ex_doc) has been updated to serve as an example of how to use this new functionality.
99+
100+
Simply running:
101+
102+
mix escript.install hex ex_doc
103+
104+
will fetch `ex_doc` and its dependencies, build them, and then install `ex_doc` to `~/.mix/escripts` (by default). After adding `~/.mix/escripts` to your `PATH`, running `ex_doc` is as simple as:
105+
106+
ex_doc
107+
108+
You can now also install archives from Hex in this way. Since they are fetched and built on the user's machine, they do not have the same limitations as pre-built archives. However, keep in mind archives run alongside every Mix project, which may lead to conflicts. For this reason, escripts is the preferred format.
109+
110+
It is also possible to install escripts and archives by providing a Git/GitHub repo. See `mix help escript.install` and `mix help archive.install` for more details.
111+
94112
## v1.4.0-rc.1 (2016-12-05)
95113

96114
### 1. Enhancements
@@ -143,12 +161,14 @@ We hope this feature provides a more streamlined workflow for developers who are
143161
#### Mix
144162

145163
* [mix archive] Compress archive files built by `mix archive` as they are now unzipped during installation
164+
* [mix archive] Install from SCM
146165
* [mix compile] Automatically infer the list of applications for Mix projects
147166
* [mix cmd] Add the ability to specify one or more apps in `mix cmd`
148167
* [mix deps] Warn if there are non-applications in the `apps` directory for umbrella projects
149168
* [mix deps] Add warning for invalid paths on `mix deps.clean`
150169
* [mix deps] Add `Mix.Project.apps_paths` that returns the paths to children applications in umbrella projects
151170
* [mix deps] Add `MIX_REBAR` environment variable for overriding local rebar
171+
* [mix escript] Install from SCM
152172
* [mix new] Check directory existence in `mix new` and ask how to proceed if one exists
153173
* [mix new] Applications built with the `--sup` flag now have an individual module to work as application callback
154174
* [mix test] Add `--formatter` option to `mix test`

0 commit comments

Comments
 (0)