Send out announcements for major new feature releases, and high-impact bugfixes to [email protected], [email protected], [email protected], [email protected], and the puppet internal mailing lists [email protected] and [email protected].
Before sending, do check that all links are still valid. Feel free to adjust the text to match better with the circumstances of the release, or add other news that are relevant at the time. If you make changes, consider committing them here, for the benefit of future-you.
The github rendering of the markdown seems to copy&paste acceptably into Google Inbox.
The CHANGELOG is a good starting point for finding enhancements and bug-fixes.
See this post for an example.
Subject: [ANN] Resource API vX.Y.Z Release
Hi all,
We're pleased to announce that version X.Y.Z of the Resource API is being released today.
The Resource API provides a simple way to create new native resources in the form of types and providers for Puppet. It is provided as a Ruby gem to be referenced within modules. Support for it has been included as an experimental feature in version 1.4 of the Puppet Development Kit (pdk new provider). Use the resource_api module or the puppet 6 nightly packages to deploy it in your infrastructure.
The new release of the Resource API provides the following enhancements:
- A
- B
- C
The new release also contains the following notable bugfixes:
- D
- E
- F
See the CHANGELOG for a full list of changes
We encourage all module developers to review the Resource API and use it when creating types and providers. For reference, there is an example of its usage in a branch of the apt module.
Please let us know of your experiences with the Resource API, either here, on Slack (#forge-modules), or on the github repo.
Thanks, YOUR NAME