Skip to content

Commit

Permalink
mention runtime.exs
Browse files Browse the repository at this point in the history
  • Loading branch information
jesseshieh committed Oct 26, 2020
1 parent 6036b65 commit 43b8e64
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/source/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ By default, the buildpacks we use include
- https://github.com/gigalixir/gigalixir-buildpack-releases

- To run mix release if you are running Elixir 1.9 and using the built-in releases
- This is only run if you have a config/releases.exs file present.
- This is only run if you have a config/releases.exs file present.

.. Note:: Elixir 1.11 adds :bash:`config/runtime.exs`. If you use that instead, then you'll want to specify buildpacks since we can no longer detect if you want releases or mix mode. See :ref:`buildpacks-releases`.

- https://github.com/gigalixir/gigalixir-buildpack-mix.git

Expand Down
2 changes: 2 additions & 0 deletions docs/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ For elixir releases, always use :elixir:`System.get_env("FOO")`, but put it in y

For example with distillery, to introduce a new :bash:`MY_CONFIG` env var is add something like this to your :bash:`prod.exs` file

.. Note:: Elixir 1.11 adds :bash:`config/runtime.exs`. If you use that instead, then you'll want to specify buildpacks since we can no longer detect if you want releases or mix mode. See :ref:`buildpacks-releases`.

.. code-block:: elixir
config :myapp,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modify-app/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you choose Elixir releases, see :ref:`modifying existing app with Elixir rele

If you choose distillery, see :ref:`modifying existing app with distillery`.

* We say easy configuration here because some customers get confused about the difference between prod.exs and releases.exs. Distillery can be even more confusing with its :bash:`REPLACE_OS_VARS` syntax.
* We say easy configuration here because some customers often get confused about the difference between prod.exs, releases.exs, and runtime.exs. Distillery can be even more confusing with its :bash:`REPLACE_OS_VARS` syntax.

.. toctree::
:hidden:
Expand Down
4 changes: 4 additions & 0 deletions docs/source/modify-app/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Configuration and Secrets

Gigalixir auto-detects that you want to use Elixir Releases if you have a :bash:`config/releases.exs` file, so let's create one.

.. Note:: Elixir 1.11 adds :bash:`config/runtime.exs`. If you use that instead, then you'll want to specify buildpacks since we can no longer detect if you want releases or mix mode. See :ref:`buildpacks-releases`.

.. code-block:: bash
echo "import Config" > config/releases.exs
Expand Down Expand Up @@ -89,6 +91,8 @@ If everything works, commit the changes
Continue to :ref:`set up deploys`.

.. _`buildpack-releases`:

Specify Buildpacks (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 43b8e64

Please sign in to comment.