Merge pull request #210 from nhsuk/version1

prepare for v1.0.0

CHANGELOG.md

@@ -1,10 +1,36 @@
 # CHANGELOG
 
-## Master
-
+## v1.0.0
+
+### Upgrade Considerations
+- Deprecated blocks `PanelBlock`, `PanelList`, `GreyPanelBlock`, `PromoBlock`, `PromoGroupBlock` have been removed from the plugin.
+- In order to replace these blocks with the recommended `CardBasicBlock`-type blocks, you should:
+    - Upgrade to v0.8.0 or v0.7.0 where the deprecated blocks exist alongside the Card blocks.
+    - Migrate `PanelBlock` and `GreyPanelBlock` to `CardFeatureBlock` as follows:
+    ```
+    label -> feature_heading
+    heading_level -> heading_level
+    body -> body
+    ```
+    - Migrate `PanelList` to `CardGroupBlock` by mapping `panels` to `body` with the `BodyStreamBlock` class and setting `columns` as `'one-half'`.
+    - Migrate `PromoBlock` to `CardImageBlock` as follows:
+    ```
+    url -> url
+    heading -> heading
+    description -> body
+    content_image -> content_image
+    alt_text -> alt_text
+    size -> heading_size
+    heading_level -> heading_level
+    ```
+    - Migrate `PromoGroupBlock` to `CardGroupBlock` by mapping `promos` to `body` using the `BodyStreamBlock` class, `column` maps to `column`. `size` and `heading_level` map to their respective fields in the child Card blocks.
+- After all deprecated blocks have been migrated, you can upgrade to v1.0.0 without any loss of data.
+
+### Changes
 - Add the organisational header variant
 - Add form component
-- Remove Panel Block, Panel List, Grey Panel Block, Promo Block, Promo Group Block
+- Remove `PanelBlock`, `PanelList`, `GreyPanelBlock`, `PromoBlock`, `PromoGroupBlock`
+- Improve test coverage
 
 ## v0.8.0
 

README.md

@@ -68,6 +68,9 @@ Include the Javascript in your base template
 ```html
   <script type="text/javascript" src="{% static 'wagtailnhsukfrontend/js/nhsuk-4.1.0.min.js' %}" defer></script>
 ```
+## Upgrading
+
+If you are upgrading from v0 to v1, see the [changelog](./CHANGELOG.md).
 
 ## Contributing 
 

docs/components/details.md

@@ -20,7 +20,6 @@ By default, the details block can contain the following sub-blocks:
 * [ActionLinkBlock](./action_link.md)
 * [InsetTextBlock](./inset_text.md)
 * [ImageBlock](./image.md)
-* [PanelBlock](./panel.md)
 * [WarningCalloutBlock](./warning_callout.md)
 * [SummaryListBlock](./summary_list.md)
 

docs/components/expander.md

@@ -20,7 +20,6 @@ By default, the expander block can contain the following sub-blocks:
 * [ActionLinkBlock](./action_link.md)
 * [InsetTextBlock](./inset_text.md)
 * [ImageBlock](./image.md)
-* [GreyPanelBlock](./grey_panel.md)
 * [WarningCalloutBlock](./warning_callout.md)
 * [SummaryListBlock](./summary_list.md)
 

docs/contributing.md

@@ -116,4 +116,4 @@ Run `pytest` in the project root.
 
 ## Support
 
-For now, we only support Python 3, Django 2.x and Wagtail 2.x
+For now, we only support Python 3, Django 3.x and Wagtail 2.x

setup.py

@@ -43,7 +43,7 @@ def run(self):
         'build': CompileCSSCommand,
     },
     name="wagtail-nhsuk-frontend",
-    version="0.8.0",
+    version="1.0.0",
     description="NHSUK Frontend Styles for Wagtail",
     author="Mike Monteith",
     author_email="<[email protected]>",