Skip to content

Commit 8cc1b01

Browse files
committed
Added upgrade instructions for v0.10.0
1 parent 5127e30 commit 8cc1b01

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

UPGRADE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22
This document describes breaking changes, as well as how to fix them, that have occured at given releases.
33
After updating your project, please consult the segments from your current release until now.
44

5+
# Upgrade to Beta 0.10.0 from Beta 0.9.0
6+
7+
## Switch IHP version
8+
9+
Open `default.nix` and change the git commit in line 4 to the following:
10+
11+
```diff
12+
-ref = "refs/tags/v0.8.0";
13+
+ref = "refs/tags/v0.10.0";
14+
```
15+
16+
After that run the following command to update your project:
17+
18+
```bash
19+
make clean
20+
nix-shell -j auto --cores 0 --run 'make -B .envrc'
21+
make -B build/ihp-lib
22+
```
23+
24+
Now you can start your project as usual with `./start`.
25+
26+
## Upgrade IHP.HtmlSupport
27+
28+
If you got an type error related to `IHP.HtmlSupport`, follow this step:
29+
30+
This error like is related to the rename of all `IHP.HtmlSupport.*` modules to `IHP.HSX.*`. You can fix this error by replacing all mentions of `IHP.HtmlSupport.` with `IHP.HSX.` in your code base.
31+
32+
## Important `data-` attribute changes
33+
34+
Boolean data attributes like `<div data-is-active={True}>` were rendered like `<div data-is-active="data-is-active">` or `<div>` (if `False`) in previous versions of IHP.
35+
36+
These boolean data attributes are now rendered like `<div data-is-active="true">` and `<div data-is-active="false">`. If you have JS code consuming your data attributes, make sure that you update the JS code.
37+
38+
Other non-data attributes like `<input disabled={True}>` are not affected by this change and will continue to render as `<input disabled="disabled"/>`.
39+
540
# Upgrade to Beta 0.9.0 from Beta 0.8.0
641

742
## Switch IHP version

0 commit comments

Comments
 (0)