Skip to content

Commit c4ed2a5

Browse files
committed
Draft 5.0 update process
1 parent 5c4237c commit c4ed2a5

File tree

4 files changed

+129
-4
lines changed

4 files changed

+129
-4
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
description: Update your installation to v5.0 from the latest v4.6 version.
3+
month_change: true
4+
---
5+
6+
# Update from v4.6 to v5.0
7+
8+
## Update from v4.6.x to v4.6.latest
9+
10+
Before you update to v5.0, you need to [update to the latest maintenance release of v4.6 (v[[= latest_tag_4_6 =]])](update_from_4.6.md).
11+
12+
## Update from v4.6.latest to v5.0.TODO
13+
14+
When you have the last version of 4.6, you can update to v5.0.
15+
16+
First, check v5.0's [requirements](requirements.md).
17+
It supports only PHP 8.3 and above.
18+
19+
### Update custom code for PHP 8.3 (TODO: 8.3+?)
20+
21+
If your DXP 4.6 is running on a PHP below 8.3, start migrating it to PHP 8.3.
22+
23+
Use Ibexa Rector to help yourself to upgrade PHP code for 8.3,
24+
see [`ibexa/rector`'s README](https://github.com/ibexa/rector?tab=readme-ov-file#ibexa-dxp-rector) for more information about installation and usage.
25+
26+
TODO: Example with our own code samples?
27+
TODO: list of features deprecated in 4.6 removed in 5.0?
28+
29+
### TODO: Other updates like moving from any deprecated stuff?
30+
31+
### Update [[= product_name =]] application
32+
33+
=== "[[= product_name_headless =]]"
34+
35+
``` bash
36+
composer require ibexa/headless:[[= latest_tag_5_0 =]] --with-all-dependencies --no-scripts
37+
composer recipes:install ibexa/headless --force -v
38+
```
39+
=== "[[= product_name_exp =]]"
40+
41+
``` bash
42+
composer require ibexa/experience:[[= latest_tag_5_0 =]] --with-all-dependencies --no-scripts
43+
composer recipes:install ibexa/experience --force -v
44+
```
45+
=== "[[= product_name_com =]]"
46+
47+
``` bash
48+
composer require ibexa/commerce:[[= latest_tag_5_0 =]] --with-all-dependencies --no-scripts
49+
composer recipes:install ibexa/commerce --force -v
50+
```
51+
52+
### composer.json clean-up
53+
54+
If you have required 4.6 LTS Update packages,
55+
they're included by default in 5.0.
56+
You can now remove them from your composer.json
57+
so you won't have to maintain which of their versions your composer.json is referring to.
58+
59+
TODO: Do it earlier?
60+
TODO: A reminding list of removable LTS Update packages
61+
62+
### Update database
63+
64+
Apply the following database update script:
65+
66+
TODO: Fix SQL file path
67+
68+
### [[= product_name =]]
69+
70+
=== "MySQL"
71+
72+
``` bash
73+
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.6.latest-to-5.0.0.sql
74+
```
75+
76+
=== "PostgreSQL"
77+
78+
``` bash
79+
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.6.latest-to-5.0.0.sql
80+
```
81+
82+
TODO: Migration files?
83+
84+
Many tables names have changed. If you have custom code directly querying these tables, you will need to update them.
85+
86+
TODO: old name/new name table
87+
88+
TODO: Compatibility "views" layers? Even if there is this layer to save time, it is recommended to update your code to use the new tables.
89+
90+
### Update custom code for [[= product_name =]] 5.0
91+
92+
TODO: Rector again, this time with 5.0 rules.
93+
94+
### Update Back Office extensions
95+
96+
TODO: Update JS, templates, CSS…
97+
TODO: Some old deprecated Webpack file names were supported in 4.6 for backward compatibility; They aren't in 5.0
98+
TODO: Conversion tables
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: Update your installation to the latest v5.0 version from an earlier v5.0 version.
3+
month_change: true
4+
---
5+
6+
# Update from v5.0.x to v5.0.latest
7+
8+
Ibexa DXP v5.0.0 is the latest version for now. If you have it, you're update-to-date.
9+
Come back to this page later to discover if some patch has been released and how to install it.
10+
11+
To update from v4.6.x, see [Update from v4.6 to v5.0](update_to_5.0.md)
12+
From older version, explore [this section](update_ibexa_dxp.md).

docs/update_and_migration/update_ibexa_dxp.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,32 @@ To update [[= product_name =]] to a newer version, select the version you're cur
1111
If you have a v1.13 installation, or a v2.x installation lower than the latest v2.5,
1212
[update to the v2.5 LTS](from_1.x_2.x/update_from_1.x_2.x.md).
1313

14-
Afterwards, it's strongly recommended to [update to the v3.3 LTS](from_2.5/update_from_2.5.md) and then update to the latest LTS, [v4.6](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6).
14+
Afterwards, it's strongly recommended to [update to the v3.3 LTS](from_2.5/update_from_2.5.md),
15+
then [update to v4.6 LTS](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6),
16+
and finally [to the lastest v5.0 LTS](from_4.6/update_to_5.0.md).
1517

1618
=== "I am using v2.5"
1719

1820
If you have a v2.5 installation, [update to the v3.3 LTS](from_2.5/update_from_2.5.md).
1921

20-
Afterwards, it's strongly recommended to also update to the latest LTS, [v4.6](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6).
22+
Afterwards, it's strongly recommended to also [update to v4.6 LTS](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6),
23+
and finally [to the lastest v5.0 LTS](from_4.6/update_to_5.0.md).
2124

2225
=== "I am using v3.3"
2326

2427
If you already have a v3.3 installation, [update to the latest v3.3 version](from_3.3/update_from_3.3.md).
2528

26-
Afterwards, it's strongly recommended to also update to the latest LTS, [v4.6](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6).
29+
Afterwards, it's strongly recommended to also [update to v4.6 LTS](from_4.5/update_from_4.5.md) (through [v4.0](from_3.3/to_4.0.md) up to v4.6),
30+
and finally [to the lastest v5.0 LTS](from_4.6/update_to_5.0.md).
2731

2832
=== "I am using v4.x"
2933

30-
If you already have a v4.x installation, [update to the v4.6 LTS](from_4.5/update_from_4.5.md).
34+
- If you have a v4.x installation prior to v4.6, [update to the v4.6 LTS](from_4.5/update_from_4.5.md).
35+
- If you have a v4.6 installation, (update to the latest patch v[[= latest_tag_4_6 =]])(from_4.6/update_from_4.6.md).
36+
37+
Afterwards, it's strongly recommended to also [update to the lastest v5.0 LTS](from_4.6/update_to_5.0.md).
38+
39+
=== "I am using v5.0"
40+
41+
If you're using [[= latest_tag_5_0 =]], You're update-to-date.
42+
Monitor [this v5.0 update page](from_5.0/update_from_5.0.md) for futur patches.

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -849,6 +849,9 @@ nav:
849849
- Update to v4.6: update_and_migration/from_4.5/update_from_4.5.md
850850
- Update from v4.6:
851851
- Update to v4.6: update_and_migration/from_4.6/update_from_4.6.md
852+
- Update to v5.0: update_and_migration/from_4.6/update_to_5.0.md
853+
- Update from v5.0:
854+
- Update to v5.0: update_and_migration/from_5.0/update_from_5.0.md
852855
- Migrate to Ibexa DXP:
853856
- Migrate from eZ Publish Platform: update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md
854857
- Migrate from eZ Publish: update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish.md

0 commit comments

Comments
 (0)