Best way to upgrade Phoenix?

Currently, I have Phoenix version 1.2.1 installed. If I want to upgrade Phoenix on my Mac to version 1.2.3 or 1.3.0-rc.1, what would be the best to do this? Surprisingly, I couldn’t find much information on this. Also, are there any version management tools for Elixir/Phoenix like there are in Ruby?



Chris McCord made a guide, follow this instructions.


If you’re asking how to upgrade the phoenix new project installer, you can run mix local.phoenix (now mix local.phx as of RC) and it will grab the latest one and install it so your mix task will be up to date.


Thank you both for replying.

@chrismccord, that was what I was looking for and it worked like a charm. Way easier than I thought. Thank you!


What is the best way to do minor upgrades like upgrading from 1.4.9 to 1.4.16?

1 Like

You need to update your mix.exs file with the latest versions, then…

$ rm -rf _build/ deps/ mix.lock
$ mix deps.get
$ mix compile

In case You need to update javascript too, for live_view, You can…

$ rm -rf assets/node_modules
$ npm install --prefix assets/

Then run your tests to see if there is no breaking change :slight_smile:


Might be worth adding that checking the diff via between the versions you are upgrading from and to, and syncing the changes to your app could be valuable for codebase maintability.

For exmaple: PhoenixDiff · v1.6.5 to v1.6.11


I’m new to Phoenix and Elixir. I recently got involved in a Phoenix api project which was build ages ago. It has the following versions:

  • Phoenix 1.3.0.
  • Elixir 1.5.1

I follow the instructions provided by the previous developer and tried to run the project. However I can’t install the older version of Elixir and Erlang to test the api. It left me to upgrade the phoenix project to 1.6.15. I followed @chrismccord guide and also followed [phoenixdiff]( and successfully migrated and ran the server.

Upon running the server, I ran into so many problems. If I tried to access the any endpoints, I run into 500 Internal Server Error. Not sure what is exactly going on and unable to figure It out how to debug the code and so. Sorry for being a newbie.

Any help on what maybe wrong and why am I getting the Error code: 500? Any helping hands?

[info] GET /api/me
[debug] Processing with
  Parameters: %{}
  Pipelines: [:api]
[info] Sent 500 in 120ms
[error] #PID<0.988.0> running Pxrfd.Web.Endpoint (connection #PID<0.987.0>, stream id 1) terminated
Server: localhost:8000 (http)
Request: GET /api/me
** (exit) an exception was raised:
    ** (FunctionClauseError) no function clause matching in Keyword.get/3
        (elixir 1.14.2) lib/keyword.ex:388: Keyword.get(:default, :key, nil)
        (guardian 2.3.1) lib/guardian/plug.ex:373: Guardian.Plug.fetch_key/2
        (guardian 2.3.1) lib/guardian/plug.ex:141: Guardian.Plug.current_resource/2
        (pxrfd 0.1.0) lib/pxrfd/web/controllers/load_resource.ex:30:
        (pxrfd 0.1.0) Pxrfd.Web.Router.api/2
        (pxrfd 0.1.0) lib/pxrfd/web/router.ex:1: Pxrfd.Web.Router.__pipe_through1__/1
        (phoenix 1.6.15) lib/phoenix/router.ex:346: Phoenix.Router.__call__/2
        (pxrfd 0.1.0) lib/plug/error_handler.ex:80: Pxrfd.Web.Router."call (overridable 3)"/2
        (pxrfd 0.1.0) lib/pxrfd/web/router.ex:1:
        (pxrfd 0.1.0) lib/pxrfd/web/endpoint.ex:1: Pxrfd.Web.Endpoint.plug_builder_call/2
        (pxrfd 0.1.0) lib/pxrfd/web/endpoint.ex:1: Pxrfd.Web.Endpoint."call (overridable 3)"/2
        (pxrfd 0.1.0) lib/pxrfd/web/endpoint.ex:1:
        (phoenix 1.6.15) lib/phoenix/endpoint/cowboy2_handler.ex:54: 

The surface cause: Guardian.Plug.fetch_key was given the atom :default where it expected a Map of options, and crashed.

The root cause appears to be a function call in load_resource.ex that looks something like current_resource(conn, :default); that API changed to current_resource(conn, opts) a long time ago.