Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backdrop 1.28.0-preview Release checklist #6500

Closed
15 of 27 tasks
quicksketch opened this issue May 2, 2024 · 5 comments
Closed
15 of 27 tasks

Backdrop 1.28.0-preview Release checklist #6500

quicksketch opened this issue May 2, 2024 · 5 comments
Milestone

Comments

@quicksketch
Copy link
Member

quicksketch commented May 2, 2024

Scheduled for May 2, 2024 10am - 4pm PT

Feature freeze ends tonight May 1, 2024. This is the issue to track the creation of Backdrop 1.28.0-preview, which will come out tomorrow May 2, 2024.

Pre-release tasks

  • Merge commits
  • Create a new minor release milestone (@quicksketch)
  • Move all unfinished issues to the next minor release milestone (@quicksketch)
  • 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.
  • Draft Release notes (@quicksketch)
    • Include a short, descriptive summary of the release, for example:
      • This is the preview release of Backdrop 1.16.0. Please use this version if you would like to help us test the features in the new version of Backdrop prior to the official release on January/May/September 15th, 20xx.
    • 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.

Pre-release Publicity + documentation tasks

  • Review issues for new features (@stpaultim / @cellear)
    • Add a conclusion suitable for blog post + release notes
    • Add Documentation label if the feature needs to be documented (or needs docs to be updated)
    • Add Needs change record label if the the issue contains an API change.
    • Add Needs translation label if the the issue contains string translations.
  • Draft blog post for release on the 15th (assign to stpaultim / tomgrandy / klonos / jenlampton)
  • Draft roadmap updates for backdropcms.org (assign to stpaultim / klonos / jenlampton)
  • Update list of modules included in backdrop core (assign to bugfolder / klonos / jenlampton)
  • Update list of modules included in backdrop_upgrade_status module (assign to jenlampton)
  • Create new forum topic for feedback on the release @stpaultim

Release tasks

  • Update bootstrap.inc with version number (e.g. 1.10.0-preview) (@quicksketch)
  • Tag for release, and push tag to GitHub (@quicksketch)
  • Note: New incremented branch for development is usually created on release day
  • Revert version number back on 1.x branch with the same minor number (e.g. 1.10.x-dev) (@quicksketch)
  • Create release notes on GitHub Important: Check "This is a pre-release" checkbox when creating release (@quicksketch)

Post-release Publicity + documentation tasks

  • Tweet that a preview release is out @stpaultim
  • Publish roadmap updates for backdropcms.org @klonos
@quicksketch quicksketch added this to the 1.28.0 milestone May 2, 2024
@quicksketch
Copy link
Member Author

quicksketch commented May 2, 2024

Release notes draft:


This is the preview release of Backdrop 1.28.0. Please use this version if you would like to help us test the features in the new version of Backdrop prior to the official release on May 15th, 2024.

This preview 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. Additional documentation and change records are being worked on for the release. In the mean time, see issue #364.

Uploading SVG images is now supported directly in image field uploads. SVGs also are integrated into the image library and image style systems.

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. More information about converting sites from file configuration to database configuration will be available as we approach the 1.28.0 release.

Dozens of other small bugs and user experience issues are included in this release. See the 1.27.2 milestone for issues that have been fixed in this release that will be bundled into both 1.28.0 and 1.27.2 when they are released.

Notes for updating

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.

No changes have been made to the .htaccess or robots.txt files. Updating customized versions of those files is not necessary.

When updating from 1.27.1, the database update script does not need to be run. However, the caches do need to be cleared. Visit admin/config/development/performance to clear the caches, or use the admin toolbar under the home icon.

New features

  • Add an icon library to core #364
  • Support uploading and viewing SVGs in the Image Library #5541
  • Make config storage swappable (store config in the database) #2277
  • Provide an easy way to get ready-to copy/paste debugging information #5791

Miscellaneous changes

  • Editors should have permission to manage files #4961
  • Restore theme_node_preview() for theming and compatibility #6129

@izmeez
Copy link

izmeez commented May 3, 2024

Very good, only a minor typo: There are also dozens over other small bugs replace over with of

@izmeez
Copy link

izmeez commented May 3, 2024

Sorry that sentence needs more:
There are also dozens of other small bug and user experience issues fixed and included in this release.

@quicksketch
Copy link
Member Author

Thanks @izmeez. Changes made in the final release notes: https://github.com/backdrop/backdrop/releases/tag/1.28.0-preview

@quicksketch
Copy link
Member Author

We're now working on the final release so this issue can be closed. See #6547

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants