From 4c86a7418493af880aa6aff94c8fa9e2621a0853 Mon Sep 17 00:00:00 2001 From: mwrock Date: Wed, 21 Feb 2018 13:20:13 -0800 Subject: [PATCH] add release notes step to release and make sure to include breaking changes Signed-off-by: mwrock --- RELEASE.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index f43b69d156..7b5c92ad51 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -3,6 +3,32 @@ This document contains step-by-step details for how to release Habitat. All components are released from the master branch on a bi-weekly schedule occurring every other Thursday. +## Submit a Release Notes Blog Post PR + +If one has not already been opened, create a "Release Notes" blog post PR. Add a file to the Habitat repo: `www/source/blog/2018-02-20-0540Release.html.md`. Of course you will change the date and version to match the reality that is manifesting itself in your present moment. This post should begin with the following structure: + +``` +--- +title: Habitat Released +date: +author: Tasha Drew +tags: release notes +category: product +classes: body-article +--- + +Habitat Release Notes + +We are happy to announce the release of Habitat . We have a number of new features as well as bug fixes, so please read on for all the details. If you just want the binaries, head on over to [Install Habitat](https://www.habitat.sh/docs/using-habitat/#install-habitat). Thanks again for using Habitat! + +Highlights: +* [BREAKING CHANGE] SOME BREAKING CHANGE +``` + +If you happen to be aware of features or bugs and feel there are user impacting words that need to be expressed, this is your opportunity to express them. Tasha will finalize and publish this PR after the release process is complete. + +**Important:** Filter all closed PRs labeled `C-breaking` and ensure any and all of these PRs is mentioned as a `[BREAKING CHANGE]` in the post highlights. + ## Prepare Master Branch for Release 1. Clone the Habitat repository if you do not already have it