Merge pull request #327 from leszczuu/fix/remove-sitemap

fix/remove sitemap

Author: leszczuu

UPGRADE.md

@@ -1,4 +1,7 @@
-# UPGRADE FROM 2.4 TO 3.0
+# UPGRADE FROM 2.4 TO 3.0 
+
+* The `stefandoorn/sitemap-plugin` dependency has been removed, and moved to the `suggest` section of composer.json.
+If you didn't require this plugin by yourselves, but want to keep the sitemap support, consider requiring it directly in your project as described [here](doc/sitemap.md).
 
 * Width and height has been added to image media. Now width and height html tags are generated in shop image.
   Read the below changelog first and then migrate your structure using 

composer.json

@@ -12,7 +12,6 @@
         "php": "^7.3",
         "league/csv": "^9.1",
         "friendsofsymfony/ckeditor-bundle": "^1.1|^2.0",
-        "stefandoorn/sitemap-plugin": "^2.0@alpha",
         "sylius/sylius": "^1.9"
     },
     "require-dev": {
@@ -42,6 +41,9 @@
         "symfony/intl": "^4.4||^5.2",
         "symfony/web-profiler-bundle": "^4.4||^5.2"
     },
+    "suggest": {
+        "stefandoorn/sitemap-plugin": "^2.0@alpha"
+    },
     "conflict": {
         "symfony/symfony": "4.1.8",
         "symfony/browser-kit": "4.1.8",

doc/installation.md

@@ -9,7 +9,6 @@ return [
     ...
 
     FOS\CKEditorBundle\FOSCKEditorBundle::class => ['all' => true], // WYSIWYG editor
-    SitemapPlugin\SitemapPlugin::class => ['all' => true], // Sitemap support
     BitBag\SyliusCmsPlugin\BitBagSyliusCmsPlugin::class  => ['all' => true],
 ];
 ```
@@ -54,7 +53,8 @@ bitbag_sylius_cms_plugin:
     resource: "@BitBagSyliusCmsPlugin/Resources/config/routing.yml"
 ```
 
-Import optional sitemap providers:
+If You have installed https://github.com/stefandoorn/sitemap-plugin according to its installation instructions
+import optional sitemap providers:
 ```yaml
 # config/services.yaml
 ...
@@ -63,6 +63,14 @@ imports:
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/services/sitemap_provider.yml" }
 ```
 
+and plugin dependency to your `config/bundles.php` file:
+```php
+return [
+    ...
+
+    SitemapPlugin\SitemapPlugin::class => ['all' => true], // Sitemap support
+];
+```
 
 Finish the installation by updating the database schema and installing assets:
 ```

doc/sitemap.md

@@ -1,6 +1,11 @@
 # Sitemap
 
-This plugin uses Sylius sitemap plugin. It's already configured with the default installation
-and contains a page & section provider. 
+This plugin suggests to install the Sylius sitemap plugin. The plugin is not installed automatically, but to install run:
+
+```bash
+    $ composer require stefandoorn/sitemap-plugin ^2.0@alpha
+``` 
+
+It's already configured after installation and contains a page & section provider. 
 
 For more information, read the original [SitemapPlugin documentation](https://github.com/stefandoorn/sitemap-plugin).

src/Resources/config/config.yml

@@ -3,7 +3,6 @@ imports:
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/fos_ck_editor/fos_ck_editor.yml" }
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/grids.yml" }
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/services.yml" }
-    - { resource: "@SitemapPlugin/Resources/config/config.yaml" }
 
 parameters:
     sylius.sitemap.path: "%kernel.project_dir%/var/sitemap"

src/Resources/config/routing.yml

@@ -5,6 +5,3 @@ bitbag_sylius_cms_plugin_admin:
 bitbag_sylius_cms_plugin_shop:
     resource: "@BitBagSyliusCmsPlugin/Resources/config/routing/shop.yml"
     prefix: /{_locale}
-
-sylius_sitemap:
-   resource: "@SitemapPlugin/Resources/config/routing.yml"

tests/Api/Sitemap/Provider/SitemapPageControllerApiTest.php

@@ -54,7 +54,6 @@
     Nelmio\Alice\Bridge\Symfony\NelmioAliceBundle::class => ['dev' => true, 'test' => true, 'test_cached' => true],
     Fidry\AliceDataFixtures\Bridge\Symfony\FidryAliceDataFixturesBundle::class => ['dev' => true, 'test' => true, 'test_cached' => true],
     FOS\CKEditorBundle\FOSCKEditorBundle::class => ['all' => true],
-    SitemapPlugin\SitemapPlugin::class => ['all' => true],
     ApiPlatform\Core\Bridge\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
     Sylius\Bundle\ApiBundle\SyliusApiBundle::class => ['all' => true],
     Lexik\Bundle\JWTAuthenticationBundle\LexikJWTAuthenticationBundle::class => ['all' => true],

tests/Application/config/bundles.php

@@ -2,5 +2,3 @@
 # https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
 parameters:
     locale: en_US
-imports:
-    - { resource: "@BitBagSyliusCmsPlugin/Resources/config/services/sitemap_provider.yml" }