Backdrop 1.28.0 Release checklist

[jenlampton]

Scheduled for May 15, 2024 4pm PT - 8pm PT

Pre-release tasks

• N/A If this is the Jan 15 release, ensure that the end year in the "All Backdrop code is Copyright..." section towards the bottom of the README.md file has been updated to reflect the new/current year.
• Merge final commits @quicksketch
• Move all unfinished issues to the next bug-fix release milestone @jenlampton
• Review all closed issues in milestone: @jenlampton
  • Issue titles should include a complete, but very brief summary of the problem.
  • Issue titles should be in complete sentences, ending with a period.
  • Bug issue titles should start with Fix or Fixed,
  • New feature issue titles should start with Add or Added.
  • Each issue should have accurate labels, especially the "type - " labels.
• Close the milestone @jenlampton
• Draft Release notes @jenlampton
  • Copy Preview release release notes, update as follows
    • Include a short, descriptive summary of the release, for example:
      • The Backdrop community is proud to release version 1.xx of Backdrop CMS, following our 4-month release cycle.
    • Include a section heading **Notes for updating**
      • Note if any changes were made to files outside the core directory, for example:
        • - No changes have been made to the `.htaccess`, `robots.txt` or default `settings.php` files in this release. Updating customized versions of those files is not necessary.
        • See this example for updates to .htaccess
        • See this example or this example for updates to settings.php
      • Note if updates (update.php) needs to be run, for example:
        • Use the text The database update script does **not** need to be run.
        • or **It will be necessary to run the update script** (located at /update.php) for this release.
    • Include a section heading **Changes since version 1.xx.x** are listed below.
      • Navigate to Actions
      • Select the most recent time "Release Notes Generator" has been run.
      • Download the release-notes artifact attached to the generator.
      • Unzip the file, and copy/pate contents into release notes draft.
      • Re-word issue titles to indicate that the problems have been fixed.
      • Note: This list can also be copied from the list on the preview release, but review closed issuses in the milestone
    • Verify the list above matches all changes since the most recent bug-fix release

Release tasks

• Update bootstrap.inc with version number @quicksketch
• Tag for release, and push tag to GitHub @quicksketch
• Branch for new minor number (e.g. 1.10.x) @quicksketch
• Revert version number back on 1.x branch with minor number increased @quicksketch
• Revert version number back on new minor number branch @quicksketch
• Create release notes on GitHub, and publish release @jenlampton
• Unpublish preview release on backdropcms.org @jenlampton
• Update the front page download link on b.org @jenlampton
• Create a new language template file for the translation server @olaf - see Add core releases and source files backdrop-ops/localize.backdropcms.org#27 until this is automated

Immediate Post-release tasks

Publicity tasks

• Tweet that a new release is out @stpaultim
  • Use text like "We're thrilled to announce Backdrop version 1.18.0. This is the 19th new feature release of #BackdropCMS. https://backdropcms.org"
• Publish blog post @jenlampton
• email [email protected] for a note in the PHP Weekly Newsletter @stpaultim
• Update the roadmap page on b.org @klonos
• Update list of modules included in backdrop core @jenlampton
• Update list of modules included in backdrop_upgrade_status module @ jenlampton
• Update the Wikipedia articles @klonos
  • https://en.wikipedia.org/w/index.php?title=Template:BackdropCMS_version&action=edit -
    • Auto applied to:
      • https://en.wikipedia.org/wiki/Backdrop_CMS
      • https://en.wikipedia.org/wiki/List_of_content_management_systems

Code tasks

• Update Tugboat @klonos
• Update Pantheon @herbdool
• Update Platform.sh @herbdool
• Update Composer @herbdool
• Update Docker @Wylbur
• Update Amezmo @jenlampton

Backdrop Website updates

• beta.backdropcms.org @bugfolder
• docs.backdropcms.org @jenlampton
• events.backdropcms.org @jenlampton
• localize.backdropcms.org @jenlampton

2-week Post-release tasks

• backdropcms.org @jenlampton
• forum.backdropcms.org @jenlampton

Publicity tasks

• Add a notification to the dashboard @stpaultim
• Send a newsletter to subscribers @stpaultim

See Also

• 1.27.2 Bug-Fix Release Checklist
• Preview Release Checklist

[jenlampton]

Release notes draft:

---

The Backdrop community is proud to release Backdrop CMS version 1.28.0!

This release includes several major new features, including a new icon system that bundles the Phosphor Icon Collection, in both "regular" and "filled" variants. The new icon system is used in the admin bar, dashboard, and admin landing pages. The new icons will start being used throughout core in the next few minor releases. They're also available for contrib developers and themers to use through the new Icon API (see the documentation for Icon API here).

Uploading SVG images is now supported directly in image field uploads. SVGs also are integrated into the image library and image style systems. Note that if you have previously used the SVG Image module, this module can now be removed as core provides equivalent functionality.

For sites that run on specialized hosting platforms (such as Pantheon, Acquia, or AWS), Backdrop 1.28.0 now allows your site to store configuration in the database instead of on the file system. This may be beneficial on systems where the file system is not as fast or reliable as database access. It also may help work with existing tools for creating backups, as the configuration will be backed up as part of the database instead of needing to be backed-up separately. Initial benchmarking has indicated database configuration is slightly slower than hosting configuration on a local SSD. Performance will vary based on your hosting configuration.

Notes for updating

• It will be necessary to run the update script (located at /core/update.php) for this release.
• No changes have been made to the .htaccess or robots.txt files. Updating customized versions of those files is not necessary.
• This release does modify the settings.php file located outside the core directory. Updating your customized copy of this file is optional. If you would like to update your copy of settings.php to include the new documentation on using different config storage systems, copy the new section on Configuration Storage from the latest version to your copy.

New features

• Allow configuration storage in alternative locations (for example: the database). #2277 (change notice)
• Add an Icon API and SVG library to core. #364 (change notice, documentation)
• Add support for SVG images. #5541 (change notice)
• Add a report with copy/paste debugging information #5791

Bug fixes

• Fixed: Install fails when using the dynamic config folder paths. #6499
• Fixed: Prevent the last item from showing up twice in the new Debug Report. #6514
• Fixed: Polish admin bar display now that it's using SVGs. #6488
• Fixed: Add an icon to the language switcher in the admin bar. #6503
• Fixed: Remove the default icon from the admin bar alert dot. #6501

Miscellaneous changes

• Add permission for managing files to the Editor role by default. #4961
• Restore theme_node_preview() for theming and compatibility #6129
• Upload Simpletest Results as an Artifact in GHA #6458

[quicksketch]

Tag is cut, ready for release: https://github.com/backdrop/backdrop/releases/tag/1.28.0

[jenlampton]

https://github.com/backdrop/backdrop/releases/tag/1.28.0 Release out! 🎉

[jenlampton]

I've added SVG Image to the list of modules in backdrop core:
https://docs.backdropcms.org/documentation/features-added-to-core

[klonos]

Does our Icon API also count as a partial/alternative implementation of https://www.drupal.org/project/icon as well?

[quicksketch]

I would say yes. It doesn't provide every possible sub-module (icon_field or icon_filter), but it does provide the API for displaying icons and supporting other icon sets.

[laryn]

I've updated the Pantheon upstream.

[klonos]

Demo sandboxes have been updated as well. Tested and working too 👍🏼

[olafgrabienski]

I've created a new language template file for the translation server.

[jenlampton]

Closing in favor of #6624