The Plone release process¶
Release process for Plone packages¶
To keep the Plone software stack maintainable, the Python egg release process must be automated to high degree. This happens by enforcing Python packaging best practices and then making automated releases using the zest.releaser tool.
This is extended with Plone coredev specific features by plone.releaser <https://github.com/plone/plone.releaser>.
Anyone with necessary PyPi permissions must be able to make a new release by running the
… which includes …
All releases must be hosted on PyPI
All versions must be tagged at version control
Each package must have
README.rstwith links to the version control repository and issue tracker
.txtin some packages) must be always up-to-date and must contain list of functional changes which may affect package users.
CHANGES.rstmust contain release dates
CHANGES.rstmust be visible on PyPI
Released eggs must contain generated gettext
.mofiles, but these files must not be committed to the repository. The
.mofiles can be created with the
zest.pocompileadd-on, which should be installed together with
MANIFEST.inmust reflect the files going to egg (must include page template, po files)
The Plone Release Team releases the core Plone packages. Several others also have the rights to release individual packages on https://pypi.org. If you have those rights on your account, you should feel free to make releases.
Some packages need special care or should be done only by specific people as they know what they are doing. These are:
Please leave these to the release managers, Eric Steele and Maurits van Rees.
Please leave this to the i18n team lead, Vincent Fretin.
Plone core release process checklist¶
Check Jenkins Status
Check latest Plone coredev job on jenkins.plone.org, it should be green, if it is not, fix the problem first.
Check out buildout.coredev
git clone email@example.com:plone/buildout.coredev.git cd buildout.coredev git checkout 5.2 python bootstrap.py bin/buildout -c buildout.cfg
Check Packages for Updates
Check all packages for updates, add to/remove from checkouts.cfg accordingly.
This script may help:
bin/manage report --interactive
This step should not be needed, because we do the check for every single commit (
but people may still have forgotten to add a package to the
Also, the automatic check currently does not work.
Check packages individually
bin/fullreleasescript from the core development buildout. This includes extra checks that we have added in
plone.releaser. It guides you through all the next steps.
Check if CHANGES.rst is up-to-date, all changes since the last release should be included, a Fixes and/or New header should be included, with the relevant changes under it. Upgrade notes are best placed here as well. Compare
git log HEAD...<LAST_RELEASE_TAG>with
CHANGES.rst. Or from zest.releaser:
lasttaglog <optional tag if not latest>.
Check package “best practices” (README.rst, CHANGES.rst, src directory)
Check if version in setup.py is correct and follows our versioning best practice
Make a release (zest.releaser:
Remove packages from auto-checkout section in
Take care of a few special packages:
If unsure, ask if
plone.staticresourcesare in sync and can be released.
If needed, ask the Plone REST api team for a new release of
Create an issue in https://github.com/collective/plone.app.locales/issues to ask the i18n team lead @vincentfretin to do a plone.app.locales release.
plone.app.upgradecontains an upgrade step for the future Plone release.
Create a pending release (directory) on dist.plone.org
Copy all core packages there.
Possibly make an alpha/beta release of CMFPlone.
Copy the versions.cfg file from coredev there.
Write an email to the Plone developers list announcing a pending release.
Update plone.app.locales version.
Create a unified changelog
Make final release on dist.plone.org (remove “-pending”)
Update the “-latest” link on dist.plone.org
Create new release on launchpad (https://launchpad.net/plone/)
Create release page on https://plone.org/download/releases
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
Send out announcement to plone-announce
Update #plone topic
- Ask the security team to update the https://plone.org/security/hotfixes/ page in the configuration control panel.