Add support for Elixir 1.9+ releases

Author: mobileoverlord

.circleci/config.yml

@@ -19,11 +19,11 @@ defaults: &defaults
 version: 2
 
 jobs:
-  build_elixir_1_8_otp_22:
+  build_elixir_1_9_otp_22:
     docker:
       - image: erlang:22.0.2
         environment:
-          ELIXIR_VERSION: 1.8.2-otp-22
+          ELIXIR_VERSION: 1.9.0-otp-22
           LC_ALL: C.UTF-8
           SUDO: true
     <<: *defaults
@@ -33,8 +33,24 @@ jobs:
       - <<: *install_hex_rebar
       - run: mix deps.get
       - run: mix format --check-formatted
-      - run: mix test
+      - run: mix test --exclude distillery
       - run: mix docs
+
+  build_elixir_1_8_otp_22:
+    docker:
+      - image: erlang:22.0.2
+        environment:
+          ELIXIR_VERSION: 1.8.2-otp-22
+          LC_ALL: C.UTF-8
+          SUDO: true
+    <<: *defaults
+    steps:
+      - checkout
+      - <<: *install_elixir
+      - <<: *install_hex_rebar
+      - run: mix deps.get
+      - run: mix test --exclude elixir_release
+
   build_elixir_1_8_otp_21:
     docker:
       - image: erlang:21.2.7
@@ -48,8 +64,7 @@ jobs:
       - <<: *install_elixir
       - <<: *install_hex_rebar
       - run: mix deps.get
-      - run: mix format --check-formatted
-      - run: mix test
+      - run: mix test --exclude elixir_release
 
   build_elixir_1_7_otp_21:
     docker:
@@ -64,9 +79,7 @@ jobs:
       - <<: *install_elixir
       - <<: *install_hex_rebar
       - run: mix deps.get
-      - run: mix format --check-formatted
-      - run: mix test
-      - run: mix docs
+      - run: mix test --exclude elixir_release
 
   build_elixir_1_6_otp_21:
     docker:
@@ -81,7 +94,7 @@ jobs:
       - <<: *install_elixir
       - <<: *install_hex_rebar
       - run: mix deps.get
-      - run: mix test
+      - run: mix test --exclude elixir_release
 
   build_elixir_1_6_otp_20:
     docker:
@@ -96,12 +109,14 @@ jobs:
       - <<: *install_elixir
       - <<: *install_hex_rebar
       - run: mix deps.get
-      - run: mix test
+      - run: mix test --exclude elixir_release
 
 workflows:
   version: 2
   build_test:
     jobs:
+      - build_elixir_1_9_otp_22:
+          context: org-global
       - build_elixir_1_8_otp_22:
           context: org-global
       - build_elixir_1_8_otp_21:

example/README.md

@@ -1,8 +1,40 @@
 # Example
 
-```
+## Build using Elixir Releases (Elixir >= 1.9.0)
+
+```bash
 mix deps.get
 mix release
-_build/dev/rel/example/bin/example console_boot `pwd`/_build/dev/rel/example/bin/shoehorn
+RELEASE_BOOT_SCRIPT=shoehorn _build/dev/rel/example/bin/example start_iex
+```
+
+## Build using Distillery (Elixir < 1.9)
+
+```bash
+mix deps.get
+mix distillery.release
+_build/dev/rel/example/bin/example console_boot $(pwd)/_build/dev/rel/example/bin/shoehorn
+```
+
+## Handling application stops
+
+Stop the main application, and watch the `Example.RestartHandler` restart it.
+
+```elixir
+iex> Application.stop(:example)
+
+:ok
+iex> Application stopped: :example %{restart_counts: 0}
+Example start
+Application started: :example
+```
+
+After 5 crashes, the vm will exit.
+
+```elixir
 iex> Application.stop(:example)
+
+15:37:58.192 [info]  Application example exited: :stopped
+Application stopped forever: :example %{restart_counts: 4}
+:ok
 ```

example/mix.exs

@@ -7,7 +7,8 @@ defmodule Example.MixProject do
       version: "0.1.0",
       elixir: "~> 1.6",
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+      releases: releases()
     ]
   end
 
@@ -19,10 +20,21 @@ defmodule Example.MixProject do
     ]
   end
 
+  def releases do
+    [
+      example: [
+        overwrite: true,
+        quiet: true,
+        steps: [&Shoehorn.Release.init/1, :assemble]
+      ]
+    ]
+  end
+
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:shoehorn, path: "../"}
+      {:shoehorn, path: "../"},
+      {:distillery, "~> 2.1"},
     ]
   end
 end

example/mix.lock

@@ -1,4 +1,4 @@
 %{
-  "artificery": {:hex, :artificery, "0.2.6", "f602909757263f7897130cbd006b0e40514a541b148d366ad65b89236b93497a", [:mix], [], "hexpm"},
-  "distillery": {:hex, :distillery, "2.0.2", "58e15f6708e355b610a48356ef170e63ec7753e35e215b107e1e87ed79c65170", [:mix], [{:artificery, "~> 0.2", [hex: :artificery, repo: "hexpm", optional: false]}], "hexpm"},
+  "artificery": {:hex, :artificery, "0.4.2", "3ded6e29e13113af52811c72f414d1e88f711410cac1b619ab3a2666bbd7efd4", [:mix], [], "hexpm"},
+  "distillery": {:hex, :distillery, "2.1.1", "f9332afc2eec8a1a2b86f22429e068ef35f84a93ea1718265e740d90dd367814", [:mix], [{:artificery, "~> 0.2", [hex: :artificery, repo: "hexpm", optional: false]}], "hexpm"},
 }

example/rel/config.exs

@@ -7,14 +7,15 @@
 |> Path.wildcard()
 |> Enum.map(&Code.eval_file(&1))
 
-use Mix.Releases.Config,
-  # This sets the default release built by `mix release`
-  default_release: :default,
-  # This sets the default environment used by `mix release`
-  default_environment: Mix.env()
+use Distillery.Releases.Config,
+    # This sets the default release built by `mix distillery.release`
+    default_release: :default,
+    # This sets the default environment used by `mix distillery.release`
+    default_environment: Mix.env()
 
 # For a full list of config options for both releases
-# and environments, visit https://hexdocs.pm/distillery/configuration.html
+# and environments, visit https://hexdocs.pm/distillery/config/distillery.html
+
 
 # You may define one or more environments in this file,
 # an environment's settings will override those of a release
@@ -28,29 +29,28 @@ environment :dev do
   # It is recommended that you build with MIX_ENV=prod and pass
   # the --env flag to Distillery explicitly if you want to use
   # dev mode.
-  set(dev_mode: true)
-  set(include_erts: false)
-  set(cookie: :"[;&(.8e$VHlk<8:mN%X%.kS/e:e&_7yqIMf?U!9*~QdJAYL{)AtG<jahu$mp/3P.")
+  set dev_mode: true
+  set include_erts: false
+  set cookie: :"%9w`A~Z/5p@B:Mc|p4DL0b$t!GIwtTG8S05}gDRx?I)KSciPDEdat{9>}lGOL4Rt"
 end
 
 environment :prod do
-  set(include_erts: true)
-  set(include_src: false)
-  set(cookie: :"(h=u)zRFgT~^oG<M_K[%9I.o|d|S7eC=HwUZwdzE<Wr4%2b~M|8}8.Uvh:baY>48")
+  set include_erts: true
+  set include_src: false
+  set cookie: :"rL2E>XTVG9P5>u4fnkFvr*z:aEAjo%.6sHB>kxVy[W_hnr2Ej*{(S3P|r!LIs^n<"
+  set vm_args: "rel/vm.args"
 end
 
 # You may define one or more releases in this file.
 # If you have not set a default release, or selected one
-# when running `mix release`, the first release in the file
+# when running `mix distillery.release`, the first release in the file
 # will be used by default
 
 release :example do
-  plugin(Shoehorn)
-  set(version: current_version(:example))
-
-  set(
-    applications: [
-      :runtime_tools
-    ]
-  )
+  set version: current_version(:example)
+  set applications: [
+    :runtime_tools
+  ]
+  plugin Shoehorn
 end
+

example/rel/vm.args

@@ -0,0 +1,30 @@
+## This file provide the arguments provided to the VM at startup
+## You can find a full list of flags and their behaviours at
+## http://erlang.org/doc/man/erl.html
+
+## Name of the node
+-name <%= release_name %>@127.0.0.1
+
+## Cookie for distributed erlang
+-setcookie <%= release.profile.cookie %>
+
+## Heartbeat management; auto-restarts VM if it dies or becomes unresponsive
+## (Disabled by default..use with caution!)
+##-heart
+
+## Enable kernel poll and a few async threads
+##+K true
+##+A 5
+## For OTP21+, the +A flag is not used anymore,
+## +SDio replace it to use dirty schedulers
+##+SDio 5
+
+## Increase number of concurrent ports/sockets
+##-env ERL_MAX_PORTS 4096
+
+## Tweak GC to run more often
+##-env ERL_FULLSWEEP_AFTER 10
+
+# Enable SMP automatically based on availability
+# On OTP21+, this is not needed anymore.
+-smp auto