| (Initial planned release date: 2023-04-04) Ensure all tickets have release notes. This query, once you've reconciled the Jira ticket fix versions in the previous step and configured the query with the current release version(s), will identify tickets whose release notes are not complete. Ask your team members to complete any tickets that need release notes (if the ticket's release note is simple you may write release notes for other people's tickets, but you certainly don't have to).
- Write release notes for the release based on the tickets found in the previous step.
One of the simplest ways to gather release notes (once you've completed the step above to ensure every ticket that needs a release note has one) is to use this Jira query be sure to replace the fixVersions with the versions you are releasing and if you don't see release notes you'll need to verify that you're in List View and add the "Release Notes", "Release Notes Summary", and "fixVersion/s" columns to the page. All those view settings are configured in the top right via the two drop-downs below Share, Export, and Tools.
- Check any tickets for a docs tab with desired information.
- The release notes go in puppetdb\/documentation\/release_notes.markdown.
- Request review from the docs team by pinging @heston in the opened PR, at least one day before Ready to Ship
- The opened PR should be approved prior to a go\/no-go. Release notes must be ready before a go.
- Docs are built daily and at release time. If notes need to be published out of band ask in `#prod-docs`.
|
