PhoenixKit.Install.Deprecations (phoenix_kit v2.15.0)

Copy Markdown View Source

Advisory deprecation notices surfaced by the installer tasks.

mix phoenix_kit.install and mix phoenix_kit.update print these so a host learns about upcoming changes while running a task they already run. Nothing here changes host code or behaviour — the deprecated features keep working exactly as before until they are actually removed in a later release.

Keeping the wording in one place means the install and update tasks can't drift, and gives a single home to escalate a notice (or drop it) as a deprecation moves through its lifecycle.

Summary

Functions

Notice that :user_dashboard_enabled now defaults to false.

Heads-up for a host that has explicitly turned the user dashboard back on.

Functions

user_dashboard_default_changed()

@spec user_dashboard_default_changed() :: String.t()

Notice that :user_dashboard_enabled now defaults to false.

For a host upgrading across the flip that never wrote the key — it took the old default without ever choosing it, and /dashboard will stop routing on the next compile. Print only when PhoenixKit.Config.user_dashboard_configured?/0 is false; a host that set the key either way already made a decision.

user_dashboard_warning()

@spec user_dashboard_warning() :: String.t()

Heads-up for a host that has explicitly turned the user dashboard back on.

Only worth printing when PhoenixKit.Config.user_dashboard_enabled?/0 is true: since the dashboard stopped being routed by default, silence is the correct output for everybody else. Advisory only — the routes still work.