From f961793a3871e3d128a51d5a03e6d99ea4f2114a Mon Sep 17 00:00:00 2001 From: Felix Eymonot Date: Mon, 30 Jan 2023 09:34:50 +0100 Subject: [PATCH 1/4] :pencil: (Doctrine) Update docs & package suggestions --- UPGRADE.md | 1 + composer.json | 2 +- docs/known_issues.md | 6 ++++++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/UPGRADE.md b/UPGRADE.md index c44e9d34..a2211d5c 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -13,3 +13,4 @@ * the new default type for mapping is "attribute". You can still use annotations, but you need an explicit definition (set "annotation" as value for "vich_uploader.metadata.type" config key) * the service "vich_uploader.current_date_time_helper" has been removed. The `DateTimeHelper` interface has been removed as well. +* if your project use `doctrine-bundle` >= 2.8 version, you must require `doctrine/annotations` in order to use annotations or attributes for mapping \ No newline at end of file diff --git a/composer.json b/composer.json index 2bfb61a8..eb4957ae 100644 --- a/composer.json +++ b/composer.json @@ -33,7 +33,6 @@ "ext-sqlite3": "*", "dg/bypass-finals": "^1.3", "doctrine/doctrine-bundle": "^2.7", - "doctrine/mongodb-odm": "^2.4", "doctrine/orm": "^2.13", "knplabs/knp-gaufrette-bundle": "dev-master", "league/flysystem-bundle": "^2.3", @@ -58,6 +57,7 @@ "symfony/yaml": "^5.4 || ^6.0" }, "suggest": { + "doctrine/annotations": "If your project use doctrine-bundle:>=2.8, this package is required to use annotations or attributes", "doctrine/doctrine-bundle": "For integration with Doctrine", "doctrine/mongodb-odm-bundle": "For integration with Doctrine ODM", "doctrine/orm": "For integration with Doctrine ORM", diff --git a/docs/known_issues.md b/docs/known_issues.md index 8a3a9cd0..4e229093 100644 --- a/docs/known_issues.md +++ b/docs/known_issues.md @@ -132,3 +132,9 @@ in a separate API call. In the other hand, for other adapters setting the metada metadata is joined with the file during the upload. To summarize, [Gaufrette support for metadata is flawed](https://github.com/KnpLabs/Gaufrette/issues/108) (see issue [GH-163](https://github.com/dustin10/VichUploaderBundle/issues/163)). + +## Doctrine/annotations package required when using doctrine-bundle >= 2.8 + +If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from your project as +it is not required in `doctrine-bundle` anymore from this version. +This bundle is using a `Reader` interface from this package in order to work for both annotations and attributes mapping. \ No newline at end of file From e5a42dfa3f5b858d24c54967ed8d5ab728cc27df Mon Sep 17 00:00:00 2001 From: Felix Eymonot Date: Mon, 30 Jan 2023 11:05:40 +0100 Subject: [PATCH 2/4] :heavy_plus_sign: (Composer) Fix package removal by mistake --- composer.json | 1 + 1 file changed, 1 insertion(+) diff --git a/composer.json b/composer.json index eb4957ae..629a8c3a 100644 --- a/composer.json +++ b/composer.json @@ -33,6 +33,7 @@ "ext-sqlite3": "*", "dg/bypass-finals": "^1.3", "doctrine/doctrine-bundle": "^2.7", + "doctrine/mongodb-odm": "^2.4", "doctrine/orm": "^2.13", "knplabs/knp-gaufrette-bundle": "dev-master", "league/flysystem-bundle": "^2.3", From 6d947053819ccdcef7936e2665c2cada21f39cb7 Mon Sep 17 00:00:00 2001 From: Felix Eymonot Date: Mon, 30 Jan 2023 11:14:18 +0100 Subject: [PATCH 3/4] :pencil: (docs) Fix markdown lint format issues --- docs/known_issues.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/known_issues.md b/docs/known_issues.md index 4e229093..bbb1a4df 100644 --- a/docs/known_issues.md +++ b/docs/known_issues.md @@ -135,6 +135,7 @@ To summarize, [Gaufrette support for metadata is flawed](https://github.com/KnpL ## Doctrine/annotations package required when using doctrine-bundle >= 2.8 -If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from your project as -it is not required in `doctrine-bundle` anymore from this version. -This bundle is using a `Reader` interface from this package in order to work for both annotations and attributes mapping. \ No newline at end of file +If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from +your project as it is not required in `doctrine-bundle` anymore from this version. +This bundle is using a `Reader` interface from this package in order to work for both annotations +and attributes mapping. From 1d5d8f66721230eeabeb24fe76ccbef1b483159c Mon Sep 17 00:00:00 2001 From: Felix Eymonot Date: Mon, 30 Jan 2023 14:04:42 +0100 Subject: [PATCH 4/4] :pencil: (docs) Fix markdown lint issues --- docs/known_issues.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/known_issues.md b/docs/known_issues.md index bbb1a4df..d95a5388 100644 --- a/docs/known_issues.md +++ b/docs/known_issues.md @@ -135,7 +135,7 @@ To summarize, [Gaufrette support for metadata is flawed](https://github.com/KnpL ## Doctrine/annotations package required when using doctrine-bundle >= 2.8 -If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from +If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from your project as it is not required in `doctrine-bundle` anymore from this version. -This bundle is using a `Reader` interface from this package in order to work for both annotations +This bundle is using a `Reader` interface from this package in order to work for both annotations and attributes mapping.