Plone 5.2.2 release checklist

[mauritsvanrees]

As one of the release managers, I want to make releases for Plone 4.3, 5.1, and 5.2 in June 2020. See also the release schedule. First up is Plone 5.2.2.

As an experiment, I want to have the status available with a checklist in an issue on GitHub, so people can follow along. From here we can link to issues that are blockers. Ultimately, it is a decision from the release team to say if an issue is really a blocker or not. But feel free to tag an issue as blocker, and link it here in a comment.

Another idea is that I create a buildout.coredev branch release-5.2.2-pending (or similar) with an empty checkouts.cfg once the package releases are done and a pending release is available on dist.plone.org. If any further releases are needed, based on feedback, I can update this branch. Once the release is final, I will create a 5.2.2 tag.

So here is the checklist, based on https://docs.plone.org/develop/coredev/docs/release.html (see source):

• Check Jenkins Status: should be green. (This should be checked often during the release process.)
• In coredev, check packages for updates: bin/manage report --interactive
• Release individual packages from checkouts.cfg.
• Check that the version numbers of CMFPlone metadata.xml and latest upgrade step are in sync.
• If unsure, ask if mockup and plone.staticresources are in sync and can be released.
• If needed, ask the Plone REST api team for a new release of plone.restapi and plone.rest.
• Write an email to the translation team, asking them to do a plone.app.locales release. Or create an issue in https://github.com/collective/plone.app.locales/issues
• Update plone.app.locales version.
• Create a pending release (directory) on dist.plone.org
  • Copy all core packages there. TODO: is there a handy command for this?
  • Possibly make an alpha/beta release of Products.CMFPlone and put it only on dist.plone.org, not PyPI.
  • Copy the versions.cfg file from coredev there.
• Create a unified changelog: bin/manage changelog
• Write a post on community.plone.org announcing a pending/soft release. See example
• Wait for feedback, preferably at most a few days.
• Make final release of Products.CMFPlone to PyPI
• Make final release on dist.plone.org (remove "-pending", make sure updated distributions are added).
• Update the "-latest" link on dist.plone.org
• Create new release on launchpad (https://launchpad.net/plone/): bin/manage launchpad <version>
• Create release page on https://plone.org/download/releases
• Announce community.plone.org, with warning that installers are not ready yet.
• Send links to installers list
• Wait for installers to be uploaded to Launchpad, link on plone.org release page
• Publish release page on plone.org
• Update plone.org homepage links to point to new release. Or really: https://plone.org/download
• Send out announcement to plone-announce
• Update #plone irc channel topic
• Ask the security team to update the https://plone.org/security/hotfixes/ page in the configuration control panel. (Configuration registry: plone.securitysupport, plone.versions, plone.activemaintenance)

[vincentfretin]

I'm going to create a list of known i18n issues here #3123

[vincentfretin]

I consider those issues as blockers

• "last modified" dates format: not the same in "View" and in "Contents" of a folder #2953
• Some translations don't get picked up in editor modals #3120
• folder_contents Configure display column dialog half visible #3124
  because there are regressions from the previous release Plone 5.2.1 or even Plone 5.2.0 compared to Plone 5.1.x

[mauritsvanrees]

Here is a full list of issues marked as 'blocker' in the whole Plone organisation.
There are 18. The oldest is from 2015. I will definitely not treat all of them as blockers for 5.2.2. But it is a useful list.

And 82 are marked as regressions, the oldest being from myself in 2013.

[mauritsvanrees]

All releases for a 5.2.2-pending have been made, most importantly CMFPlone 5.2.2rc1.

I have created a coredev branch release-5.2.2-pending with an empty checkouts.cfg. Please do not make any changes there, let me or someone else on the release team manage this branch. It should be a short-lived branch, replaced by a tag 5.2.2 eventually.

I have created https://dist.plone.org/release/5.2.2-pending/ with at the moment only the versions.cfg, requirements.txt and constraints.txt copied from this coredev branch. Note that constraints.txt is generated automatically when running bin/buildout. I will copy the package files here as well.

[mauritsvanrees]

I have uploaded the packages to https://dist.plone.org/release/5.2.2-pending/

Note to self, to gather all packages, edit a buildout config file in coredev (I used checkouts.cfg) and add:

eggs-directory = eggs
download-cache = downloads

This counters the shared directories I have specified in ~/.buildout/default.cfg.

Then run bootstrap.sh. Afterwards run bootstrap-py3.sh to get extra packages for Python 3 only.

At the end, or in between, cd downloads/dist and sync this with the server: rsync -a . dist.plone.org:dist/ and afterwards move the contents of the remote dist directory to the proper pending directory.

Note that when I do this, I get a few Mac OSX specific wheels:

zope.interface-5.0.2-cp27-cp27m-macosx_10_9_x86_64.whl
zope.interface-5.0.2-cp37-cp37m-macosx_10_9_x86_64.whl

It would be nicer to only have the source distributions (tar.gz usually).

[vincentfretin]

Thank you for your hard work making the releases!
I released plone.app.locales 5.1.23 just now, can you please include it?

[mauritsvanrees]

Thank you for your hard work making the releases!
I released plone.app.locales 5.1.23 just now, can you please include it?

Thanks, I have included it.

[ale-rt]

I spotted a breaking change that is fixed by plone/plone.app.layout#240

[ale-rt]

I would also add #3135 as a blocker.

[vincentfretin]

I made various i18n fixes in the following packages, it would be great to have those fixes in Plone 5.2.2.

• plone.app.content (Some messages are not internationalized in folder_constraintypes_form #3127 and internationalized "MIME Type" column related to Collection edit screen inconsistent naming of table columns #2597)
• plone.app.contenttypes (Collection edit screen inconsistent naming of table columns #2597)
• plone.app.discussion (closing some input tags, not really necessary to release)
• plone.app.z3cform ("Error" not internationalized in Document add form #3126)
• plone.app.vocabularies (Collection edit screen inconsistent naming of table columns #2597)
• plone.app.locales (pickadate widget doesn't use the correct 24h format in some languages #3134 and html tag show up in info message in empty dashboard #3128 and French: Typo "Content-Type" collective/plone.app.locales#311)

[mauritsvanrees]

Blockers:

• The attrs variable is not available anymore in page template #3135

Nice to have:

• noLongerProvides seems broken -> ValueError plone.dexterity#126 (could be called a blocker, but it's tricky and there is no movement yet)
• Three test failures in test_dxfield_serializer when using 6.13.4 plone.restapi#974 (only a test fix)

Further, we will want new releases of:

• plone.app.layout
• plone.app.upgrade
• probably all the ones Vincent mentions in the previous comment

I can see the danger of including more and more changes and then never actually finishing the release...

[vincentfretin]

Blockers:

• To be confirmed, in plone.app.upgrade, upgrade step missing for plone.app.discussion 1001 → 1002 ?(https://community.plone.org/t/plone-5-2-2-soft-released/12487/23) => not an issue see https://community.plone.org/t/plone-5-2-2-soft-released/12487/35 and I tested myself a Plone 5.2.1 to 5.2.2 migration on a newly created Plone 5.2.1.

A message was not internationalized for the new Custom CSS feature:

• plone.app.theming (Internationalized the Custom CSS placeholder plone.app.theming#186)

[vincentfretin]

plone/plone.dexterity#126 is not a blocker anymore

For chameleon #3135 discussion is ongoing.

I'm releasing a last version of plone.app.locales tomorrow morning CET.

[mauritsvanrees]

At this point, I don't feel comfortable making 5.2.2 final with Zope 4.4.4. There are too many reports of template problems.
Going back to 4.3 is on the table as option for this release.
But I will sleep now, and then go on vacation for a week, so a decision will have to wait. Sorry about that!

[tkimnguyen]

This is your call! And I would trust your instincts. Have a great vacation week celebrating Canada Day! 🇨🇦 😆

[vincentfretin]

Have a great vacation!
I will delay the plone.app.locales release for a week then, no hurry. :-)

[vincentfretin]

While you're on vacation, we continue fixing issues :-)

• Products.CMFCore 2.4.8 (I updated versions.cfg in buildout.coredev 5.2, see Fix indexing queue issue with UNINDEX followed by REINDEX zopefoundation/Products.CMFCore#96)
• plone.app.content (Pass messages from translate method to get them translated in JSON results used later by folder_contents view plone.app.content#205 and Expose pickadate pattern options in property editing template plone.app.content#206)
• plone.app.contentmenu (fix state icon position in toolbar when no permission plone.app.contentmenu#29)
• plone.app.contenttypes (Image template is way too much informative plone.app.contenttypes#554 and Avoid doing the search twice in listings by reusing the batch variable plone.app.contenttypes#561)
• new release for plone.app.contenttypes branch 1.1.x for Plone 4.3.x and please add a comment with the new version in Avoid doing the search twice in listings by reusing the batch variable (Plone 4.3) plone.app.contenttypes#562)
• plone.app.layout (translate modal title (for Log in modal for example) plone.app.layout#241)
• plone.app.users (Unneeded arrow next to Site Setup button in "Edit Member Form Fields" plone.app.users#93)
• plone.staticresources (Update bundles (step 9) plone.staticresources#91)
• plonetheme.barceloneta (Show scrollbars only if needed plonetheme.barceloneta#205 and Several styles fixes plonetheme.barceloneta#206 and Make input placeholder appear lighter plonetheme.barceloneta#207)
• plone.app.locales 5.1.24 released, please include it in Plone 5.2.2

[mauritsvanrees]

I have updated https://dist.plone.org/release/5.2.2-pending

Remaining known issues:

• We will want a Zope 4.5.1 release with more template fixes: https://github.com/zopefoundation/Zope/blob/4.x/CHANGES.rst
• We may need an adapter in CMFPlone for the final template fixes: traversing macro doesn't works, testing upgrade to Plone 5.2.2 (pending) #3141 (comment), unless this gets done in Zope itself. PR: Return a Zope aware engine for page templates based on zope.pagetemplate #3149

[mauritsvanrees]

With my Security Team hat on I want this in, to ease future hotfixes:

• Put isURLInPortal in separate package: Split isURLInPortal off into Products.isurlinportal #3150

With my Release Manager hat on, I grumble about this, but grudgingly agree.

[mauritsvanrees]

New one about dependencies, should be easy to fix:

• Invalid dependency on p.a.caching plone.app.theming#187

[mauritsvanrees]

• Fix for incompatibility with new ZODB 5.6.0: Fixed incompatibility with ZODB 5.6. zopefoundation/zodbupdate#37

[mauritsvanrees]

I have done a couple more releases, some fixing issues mentioned above, plus some small bug fixes.
Only remaining blocker as far as I am concerned is now a Zope 4.5.1 release containing template/chameleon fixes, which I asked about today.

[mauritsvanrees]

ZEO and Zope releases are available, changes merged to coredev.
I will note one more issue on Windows: plone/plone.recipe.zope2instance#144. But I won't treat it as a blocker: we have waited far far longer than I wanted to already.

[mauritsvanrees]

I have made release candidate 5.2.2rc3:
https://dist.plone.org/release/5.2.2-pending/

[mauritsvanrees]

And 5.2.2 is final!
Release notes are here: https://dist.plone.org/release/5.2.2/RELEASE-NOTES.txt

Now I need to get back to my earliest checklist above.

[mauritsvanrees]

Note that based on coredev branch release-5.2.2-pending I have made tag 5.2.2.
I will remove the branch in a few days, but will keep the tag.

[avoinea]

• plone Docker Official Image release on DockerHub: Plone 5.2.2 release plone.docker#138