added migration steps to v2.5.0 #149
Conversation
README.md
Outdated
| @@ -21,6 +21,26 @@ When you run `npm run build` the terminal will output the error, including the h | |||
|
|
|||
|  | |||
|
|
|||
| ## Migration | |||
|
|
|||
| In general, most upgrades wont require any migration steps to work, but if you experience problems after an upgrade, please file an issue, and we'll add it to the list of migration steps below. | |||
| } | ||
| ``` | ||
|
|
||
| To fix this, create a new file *in the root of the project* called `tsconfig.test.json`, and paste [the content of this file into it](https://raw.githubusercontent.com/wmonk/create-react-app-typescript/master/packages/react-scripts/template/tsconfig.test.json). Everything should work now. For more info, please see [this issue](https://github.com/wmonk/create-react-app-typescript/issues/141). |
There was a problem hiding this comment.
Should we link to a commit version of tsconfig.test.json instead of the master version? Could cause issues in the future if the file doesn't exist.
There was a problem hiding this comment.
I thought about that to, however I think that linking to the master version is more future proof. Say we release a version eg. 2.11.0 that requires some additional configurations in that file. When one tries to migrate from 2.4.0 to 2.11.0 they would have to insert the new configs as well, and not just the ones introduced in 2.5.0, which is an argument to why we always want to link to the most up-to-date version.
If we one day remove the config all together, maybe we should change the migration guide to say something like "From <2.5.0 to 2.5.0 - 2.10.0" to emphasise that the configuration is only necessary between those version, and was removed later on.
Thoughts?
There was a problem hiding this comment.
Yeah sounds good to me. Lets leave as is!
Fixes #141
Added Migration section to the README.md