Release note for #11858

CHANGELOG.txt

@@ -5,6 +5,7 @@ Changelog
 ~~~~~~~~~~~~~~~~
 
  * Optimize and consolidate redirects report view into the index view (Jake Howard, Dan Braghis)
+ * Support a `HOSTNAMES` parameter on `WAGTAILFRONTENDCACHE` to define which hostnames a backend should respond to (Jake Howard, sponsored by Oxfam America)
 
 
 6.1 (xx.xx.xxxx) - IN DEVELOPMENT

docs/reference/contrib/frontendcache.md

@@ -105,6 +105,10 @@ WAGTAILFRONTENDCACHE = {
 }
 ```
 
+```{versionchanged} 6.2
+Previous versions allowed passing a dict for `DISTRIBUTION_ID` to allow specifying different distribution IDs for different hostnames. This is now deprecated; instead, multiple distribution IDs should be defined as [multiple backends](frontendcache_multiple_backends), with a `HOSTNAMES` parameter to define the hostnames associated with each one.
+```
+
 Configuration of credentials can done in multiple ways. You won't need to store them in your Django settings file. You can read more about this here: [Boto 3 Docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html). The user will need a policy similar to:
 
 ```json

docs/releases/6.2.md

@@ -15,6 +15,7 @@ depth: 1
 ### Other features
 
  * Optimize and consolidate redirects report view into the index view (Jake Howard, Dan Braghis)
+ * Support a [`HOSTNAMES` parameter on `WAGTAILFRONTENDCACHE`](frontendcache_multiple_backends) to define which hostnames a backend should respond to (Jake Howard, sponsored by Oxfam America)
 
 ### Bug fixes
 
@@ -31,6 +32,40 @@ depth: 1
 
 ## Upgrade considerations - changes affecting all projects
 
+### Specifying a dict of distribution IDs for CloudFront cache invalidation is deprecated
+
+Previous versions allowed passing a dict for `DISTRIBUTION_ID` within the `WAGTAILFRONTENDCACHE` configuration for a CloudFront backend, to allow specifying different distribution IDs for different hostnames. This is now deprecated; instead, multiple distribution IDs should be defined as [multiple backends](frontendcache_multiple_backends), with a `HOSTNAMES` parameter to define the hostnames associated with each one. For example, a configuration such as:
+
+```python
+WAGTAILFRONTENDCACHE = {
+    'cloudfront': {
+        'BACKEND': 'wagtail.contrib.frontend_cache.backends.CloudfrontBackend',
+        'DISTRIBUTION_ID': {
+            'www.wagtail.org': 'your-distribution-id',
+            'www.madewithwagtail.org': 'other-distribution-id',
+        },
+    },
+}
+```
+
+should now be rewritten as:
+
+```python
+WAGTAILFRONTENDCACHE = {
+    'mainsite': {
+        'BACKEND': 'wagtail.contrib.frontend_cache.backends.CloudfrontBackend',
+        'DISTRIBUTION_ID': 'your-distribution-id',
+        'HOSTNAMES': ['www.wagtail.org'],
+    },
+    'madewithwagtail': {
+        'BACKEND': 'wagtail.contrib.frontend_cache.backends.CloudfrontBackend',
+        'DISTRIBUTION_ID': 'other-distribution-id',
+        'HOSTNAMES': ['www.madewithwagtail.org'],
+    },
+}
+```
+
+
 ## Upgrade considerations - deprecation of old functionality
 
 ## Upgrade considerations - changes affecting Wagtail customisations