search

nhsuk / wagtail-nhsuk-frontend

A wagtail implementation of the NHS.UK frontend library
MIT License
21 stars 13 forks source link

Deprecation timescales #195

Closed dragondave closed 3 years ago

dragondave commented 3 years ago

What is the likely timescale or version when the deprecated blocks like GreyPanelBlock will be removed? Could this be documented?

dragondave commented 3 years ago

Looks pretty imminent https://github.com/nhsuk/wagtail-nhsuk-frontend/pull/194

mikemonteith commented 3 years ago

I'd guess within the next couple of weeks. We will be releasing a major version upgrade (version 1.0.0) with those deprecated blocks removed - they have been removed from the service manual for a while now.

@dragondave I'd be interested in knowing how much of a headache this is going to be for you to upgrade?

dragondave commented 3 years ago

We're investigating now. My gut feeling is that it isn't a major concern; we've explicitly pinned to 0.7.0 to avoid issues for now. Is there an obvious upgrade path?

mikemonteith commented 3 years ago

Our own upgrade path is just to manually replace deprecated blocks with the new ones before upgrading to v1.0.0. This is fine for us as we only use the deprecated blocks in a handful of places. (it should be noted that removing or changing blocks in streamfield definitions will cause page revisions to become un-restorable but this isn't an issue for us either).

Another upgrade path would be to write a custom migration with migrations.RunPython to alter page data (and page revision data, if required). This is significantly more tricky

dragondave commented 3 years ago

That's super helpful -- thank you very much for your insight!