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

add release notes step to release and make sure to include breaking changes #4653

Merged
merged 1 commit into from Feb 21, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 26 additions & 0 deletions RELEASE.md
Expand Up @@ -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 <VERSION> Released
date: <yyyy-mm-dd>
author: Tasha Drew
tags: release notes
category: product
classes: body-article
---

Habitat <VERSION> Release Notes

We are happy to announce the release of Habitat <VERSION>. 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
Expand Down