Skip to content

Commit 1560fa1

Browse files
mnocondabrt
andcommitted
Added more mentions about clearing persistence cache (#3174)
* Added more mentions about clearing persistence cache * Self review * Apply suggestions from code review Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com> * Vale remarks * Should -> consider comitting * Apply suggestion from @mnocon --------- Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
1 parent 2c2a298 commit 1560fa1

2 files changed

Lines changed: 117 additions & 3 deletions

File tree

docs/snippets/page_block_cache_clear.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Persistence cache must be cleared after any modifications have been made to the block config in Page Builder, such as adding, removing or altering the page blocks, block attributes, validators or views configuration.
44

5-
To clear the persistence cache run `./bin/console cache:pool:clear [cache-pool]` command.
6-
The default cache-pool is named `cache.tagaware.filesystem`.
7-
The default cache-pool when running Redis or Valkey is named `cache.redis`.
5+
To clear the persistence cache, run `php bin/console cache:pool:clear <cache-pool>` command.
6+
The default cache pool is named `cache.tagaware.filesystem`.
7+
The default cache pool when running Redis or Valkey is named `cache.redis`.
88
If you have customized the [persistence cache configuration](https://doc.ibexa.co/en/latest/infrastructure_and_maintenance/cache/persistence_cache/#what-is-cached), the name of your cache pool might be different.
99

1010
In prod mode, you also need to clear the symfony cache by running `./bin/console c:c`.

docs/update_and_migration/from_5.0/update_from_5.0.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,120 @@ Additionally, you must remove the following line from your `.platform.app.yaml`
331331
curl -fs https://get.symfony.com/cloud/configurator | bash
332332
```
333333

334+
## v5.0.7
335+
336+
### Update Symfony from 7.3 to 7.4
337+
338+
This version of [[= product_name =]] requires [Symfony 7.4](https://symfony.com/releases/7.4).
339+
Update Symfony constraints in `composer.json` before updating the packages.
340+
341+
1. In `composer.json`, update `extra.symfony.require` to allow installing a higher Symfony version:
342+
343+
```json
344+
"extra": {
345+
"symfony": {
346+
"require": "7.4.*"
347+
}
348+
}
349+
```
350+
351+
2. To allow installing Symfony 7.4, update the requirements for **all** `symfony` packages in `composer.json` as in the example below:
352+
353+
``` diff
354+
- "symfony/<package>"": "7.3.*",
355+
+ "symfony/<package>"": "7.4.*",
356+
```
357+
358+
3. Review your code, configuration, and third-party bundles for Symfony 7.4 compatibility.
359+
360+
For more details about the new version, see the official Symfony [upgrade instructions](https://github.com/symfony/symfony/blob/7.4/UPGRADE-7.4.md) and [blog posts introducing this release](https://symfony.com/blog/category/living-on-the-edge/8.0-7.4).
361+
Key changes include:
362+
363+
364+
- Independent application cache directory
365+
366+
Symfony 7.4 introduces a new [share directory](https://symfony.com/blog/new-in-symfony-7-4-share-directory), dedicated for storing application cache on the file system.
367+
If you decide to configure it (for example, by setting the `APP_SHARE_DIR` environment variable), review your existing scripts for explicit `var/cache` usage (for example, `rm -rf var/cache`) and decide whether to include `var/share` in the script.
368+
369+
!!! caution "Always clear the persistence cache with `cache:pool:clear` command"
370+
371+
Starting with Symfony 7.4, running `php bin/console cache:clear` doesn't clear the [[= product_name =]] persistence cache, even when using a filesystem-based cache pool.
372+
373+
To clear the persistence cache, for example after adding a [custom Page Builder block](create_custom_page_block.md), you must always run:
374+
375+
```bash
376+
php bin/console cache:pool:clear <cache-pool>
377+
```
378+
379+
The default cache pool is named `cache.tagaware.filesystem`.
380+
The default cache pool when running Redis or Valkey is named `cache.redis`.
381+
If you have customized the persistence cache configuration, the name of your cache pool might be different.
382+
383+
For more information about persistence cache, see [Persistence cache](persistence_cache.md).
384+
385+
- Array-based PHP configuration format
386+
387+
As part of the new [array-based PHP configuration format](https://symfony.com/blog/new-in-symfony-7-4-better-php-configuration), Symfony creates the `config/reference.php` file.
388+
Consider committing this file to the repository.
389+
390+
4. Update Ibexa packages by running:
391+
392+
=== "[[= product_name_headless =]]"
393+
394+
``` bash
395+
yarn upgrade @ibexa/frontend-config @ibexa/ts-config
396+
composer require ibexa/headless:v5.0.7 --with-all-dependencies --no-scripts
397+
composer recipes:install ibexa/headless --force -v
398+
```
399+
=== "[[= product_name_exp =]]"
400+
401+
``` bash
402+
yarn upgrade @ibexa/frontend-config @ibexa/ts-config
403+
composer require ibexa/experience:v5.0.7 --with-all-dependencies --no-scripts
404+
composer recipes:install ibexa/experience --force -v
405+
```
406+
=== "[[= product_name_com =]]"
407+
408+
``` bash
409+
yarn upgrade @ibexa/frontend-config @ibexa/ts-config
410+
composer require ibexa/commerce:v5.0.7 --with-all-dependencies --no-scripts
411+
composer recipes:install ibexa/commerce --force -v
412+
```
413+
414+
5. Manually restore the entry for `JMSTranslationBundle` in `config/bundles.php` to [its previous position](https://github.com/ibexa/commerce-skeleton/blob/v5.0.6/config/bundles.php#L14):
415+
416+
``` hl_lines="2"
417+
FOS\HttpCacheBundle\FOSHttpCacheBundle::class => ['all' => true],
418+
JMS\TranslationBundle\JMSTranslationBundle::class => ['all' => true],
419+
Liip\ImagineBundle\LiipImagineBundle::class => ['all' => true],
420+
```
421+
422+
You're now running [Symfony 7.4, the current long-term support version](https://symfony.com/releases/7.4).
423+
424+
### [[= product_name_cloud =]] `ibexa:setup` command deprecation
425+
426+
Following the changes introduced in v5.0.6, the `ibexa:setup` command is deprecated as of v5.0.7 and will be removed in v6.0.0.
427+
Additionally, the `ibexa/cloud` package must be installed for the [[= product_name_cloud =]] build to succeed.
428+
The command `ibexa:cloud:setup` from this package replaces the deprecated `ibexa:setup`.
429+
430+
To learn how to adjust your configuration, see [update instructions for v5.0.6](#ibexa-cloud-configuration-update).
431+
432+
### Database update [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
433+
434+
Run the provided SQL upgrade script to update your database:
435+
436+
=== "MySQL"
437+
438+
``` bash
439+
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-5.0.6-to-5.0.7.sql
440+
```
441+
442+
=== "PostgreSQL"
443+
444+
``` bash
445+
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-5.0.6-to-5.0.7.sql
446+
```
447+
334448
## LTS Updates and additional packages
335449

336450
[LTS Updates](editions.md#lts-updates) are standalone packages with their own update procedures.

0 commit comments

Comments
 (0)