Merge pull request #331 from creative-commoners/pulls/5/static

DOC Staticpublishqueue changelog entry
silverstripe · Aug 30, 2023 · 739caea · 739caea
2 parents 93c1b43 + 9797fc1
commit 739caea
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/en/04_Changelogs/5.1.0.md b/en/04_Changelogs/5.1.0.md
@@ -14,6 +14,7 @@ title: 5.1.0 (unreleased)
   - [New `InheritedPermissions` option - only these members](#only-these-members)
   - [Optimised queries when filtering against IDs](#filter-by-ids)
   - [Session manager anonymize stored IP addresses](#session-manager-ip)
+  - [Static publish queue related page regeneration](#staticpublishqueue-regeneration)
   - [Other new features](#other-features)
 - [API changes](#api-changes)
 - [Dependency changes](#dependency-changes)
@@ -126,6 +127,23 @@ SilverStripe\SessionManager\Models\LoginSession:
   anonymize_ip: true
 ```
 
+### Static publish queue related page regeneration {#staticpublishqueue-regeneration}
+
+New configuration options have been added to [Static Publish Queue](https://github.com/silverstripe/silverstripe-staticpublishqueue) to force regeneration of related pages after publishing or unpublishing a related page. You can enable this with the following configuration:
+
+```yml
+SilverStripe\CMS\Model\SiteTree:
+  regenerate_children: recursive
+  regenerate_parents: recursive
+```
+
+Available options are:
+- `none`: Do not regenerate any parent or child hierarchy
+- `direct`: Regenerate only one level above or below (direct parent or children, but not grandparent or grandchildren)
+- `recursive`: Regenerate the entire parent or child hierarchy
+
+Read more about new [configuration options](https://github.com/silverstripe/silverstripe-staticpublishqueue/blob/6/docs/en/basic_configuration.md#control-when-childparent-pages-are-regenerated-in-cache-actions).
+
 ### Other new features
 
 - You can now exclude specific `DataObject` models from the check and repair step of `dev/build` - see [ORM Performance](/developer_guides/performance/orm/#skip-check-and-repair) for more information.