Skip to content

Commit

Permalink
[docs] Update UPGRADING file
Browse files Browse the repository at this point in the history
  • Loading branch information
cpjolicoeur committed May 16, 2023
1 parent fa5de1c commit fabdaa7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
9 changes: 7 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,13 @@ of `Phoenix.View` in the core SDK, the way the templates are created, and the co
generated by Torch have changed significantly.

There is no automatic upgrade path for existing files that were generated with previous versions of Torch.
You can either continue to use Torch v4, or manually update your existing Torch templates to the new unified
function component style provided by `Phoenix.Component`.
If you encounter issues using Torch v5 with existing templates, you can either continue to use Torch v4,
or manually update your existing Torch templates to the new unified function component style
provided by `Torch.Component`.

Templates that were generated with Torch v4 _should_ still funtion, if you manaully included `:phoenix_view`
in your projects mix dependencies, but your results may vary. For templates generated with Torch v4, you
would also need to make the manual updates described below in the "Torch v3 to Torch v4" section.

#### Slime support dropped

Expand Down
5 changes: 3 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ defmodule Torch.MixProject do
[
maintainers: ["MojoTech"],
licenses: ["MIT"],
files: ~w(lib priv mix.exs README.md LICENSE CHANGELOG.md CODE_OF_CONDUCT.md),
files: ~w(lib priv mix.exs README.md LICENSE CHANGELOG.md CODE_OF_CONDUCT.md UPGRADING.md),
links: %{
"Github" => @source_url
}
Expand All @@ -74,7 +74,8 @@ defmodule Torch.MixProject do
"CHANGELOG.md": [title: "Changelog"],
"CODE_OF_CONDUCT.md": [title: "Code of Conduct"],
LICENSE: [title: "License"],
"README.md": [title: "Overview"]
"README.md": [title: "Overview"],
"UPGRADING.md": [title: "Upgrading"]
],
main: "readme",
source_ref: "v#{@version}",
Expand Down

0 comments on commit fabdaa7

Please sign in to comment.