- Added a brand new Pull Request Template to aid developers in the new Release Notes process.
- Must-Use Plugins added
- Release Notes 1.0.0
- Reads from the header block in style.css for a new property called “Release Notes”.
- If specified with a correct Category slug, WordPress will display a Release Notes meta box on the Dashboard.
- The Dashboard meta box will display the latest Release Notes for the theme as well as WordPress Cluster releases.
- Each Release Notes post on the Dashboard meta box clicks through to the WordPress Cluster – Release Notes website.
- Combines Release Notes slugs from child and parent themes.
- Release Notes 1.0.0
Pull Request: https://github.com/dc-thomson/wordpress/pull/823
Updating style.css Files
To get the Dashboard widget to appear, you will need to update the theme’s style.css file header to include the new “Release Notes:”. The following is an example based on the Blocks theme.
The amendment is highlighted in bold and lists the category slugs which are relevant to that release. It can include multiple slugs for different, relevant releases if applicable.
Please note: WordPress Cluster is included separately any way, therefore there is no need to add it manually in the theme.
/* Theme Name: Blocks Theme URI: Author: Robert Paul Author URI: http://www.dcthomson.co.uk Description: A flexible Blocks theme with Customizer options. Version: 1.1.0 License: License URI: Tags: Release Notes: blocks-theme,esio,syndicate */
New Release Notes process
By the fact you are reading this means you have some inclination that a change is occurring. This area is optional but can be use to provide useful information on the new release such as animated GIF walk-through, screenshots, links to third parties or even an example of the new functionality (if it is say an embed).
In this case, it is a link to Confluence with detailed instructions on the new Release Notes process.