ash-project/ash_phoenix
1
0
Fork 0
mirror of https://github.com/ash-project/ash_phoenix.git synced 2024-09-19 06:42:47 +12:00
Code Issues Projects Releases Packages Wiki Activity

docs: add upgrade doc

Browse source
This commit is contained in:
Zach Daniel 2024-03-28 19:16:25 -04:00
parent 01ca583443
commit b3559d87b6
2 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
documentation/how_to/upgrade.md Normal file
View file

@ -0,0 +1,9 @@
# Upgrading from 2.0 to 3.0
There are a few major changes in 3.0 that you should be aware of that affect AshPhoenix's behavior.
1. You don't need to pass in the `domain` to your forms.
2. Extra inputs are no longer accepted by actions. This means that if you were using custom form parameters, you may run into issues. There is a new option when constructing forms, `skip_unknown_inputs: ["foo", "bar"]` that allows you to skip these, but they don't currently apply to nested forms. If you need this, or encounter any issues, please open an issue.
3. When calling `AshPhoenix.Form.params/1`, for the same reasons as above, it will no longer return the hidden fields from the form. If you need these, you can add the `hidden?: true` option to `AshPhoenix.Form.params/1`.

3
mix.exs
View file

@ -61,7 +61,8 @@ defmodule AshPhoenix.MixProject do
logo: "logos/small-logo.png",
extras: [
"documentation/tutorials/getting-started-with-ash-and-phoenix.md",
"documentation/topics/working-with-phoenix.md"
"documentation/topics/working-with-phoenix.md",
"documentation/how_to/upgrade.md"
],
groups_for_extras: [
Tutorials: ~r'documentation/tutorials',