add configuration to enable/disable auto-start of incremental releases

Author: erickloss

Classes/IncrementalContentReleaseHandler.php

@@ -4,9 +4,6 @@
 namespace Flowpack\DecoupledContentStore;
 
 use Neos\Flow\Annotations as Flow;
-use Flowpack\Prunner\PrunnerApiService;
-use Flowpack\Prunner\ValueObject\PipelineName;
-use Neos\Fusion\Core\Cache\ContentCache;
 
 /**
  * @Flow\Scope("singleton")
@@ -19,6 +16,11 @@ class IncrementalContentReleaseHandler
      */
     protected $contentReleaseManager;
 
+    /**
+     * @Flow\InjectConfiguration("startIncrementalReleaseOnWorkspacePublish")
+     */
+    protected $startIncrementalReleaseOnWorkspacePublish;
+
     protected $nodePublishedInThisRequest = false;
 
     public function nodePublished()
@@ -28,8 +30,8 @@ public function nodePublished()
 
     public function startContentReleaseIfNodesWerePublishedBefore()
     {
-        if ($this->nodePublishedInThisRequest === true) {
+        if ($this->startIncrementalReleaseOnWorkspacePublish === true && $this->nodePublishedInThisRequest === true) {
             $this->contentReleaseManager->startIncrementalContentRelease();
         }
     }
-}
+}

Configuration/Settings.yaml

@@ -1,5 +1,10 @@
 Flowpack:
   DecoupledContentStore:
+
+    # auto-start an incremental release whenever a workspace publish happens
+    # if you want to disable auto-start of incremental releases, set this to false
+    startIncrementalReleaseOnWorkspacePublish: true
+
     redisContentStores:
       # the "Primary" content store is the one Neos writes to during building the content release.
       primary:

README.md

@@ -239,6 +239,20 @@ As a big improvement for stability (compared to v1), the rendering pipeline does
 it is a full or an incremental render. To trigger a full render, the content cache is flushed before
 the rendering is started.
 
+### auto-starting of Incremental Releases on workspace changes
+
+By default, the Package is configured to automatically start an incremental release whenever any workspace is published.
+This behavior can be disabled via Flow configuration in your Settings.yaml
+
+```yaml
+Flowpack:
+  DecoupledContentStore:
+    # if you want to disable auto-start of incremental releases, set this to false
+    # (default value: true)
+    startIncrementalReleaseOnWorkspacePublish: false
+    # ...
+```
+
 ### What happens if edits happen during a rendering?
 
 If a change by an editor happens during a rendering, the content cache is flushed (by tag) as a result of