Skip to content

Commit 03e8c14

Browse files
authored
Merge pull request #691 from BrentOzarULTD/issue_690/brent
#690 adding release documentation
2 parents d139862 + 9cc480d commit 03e8c14

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# First Responder Kit Release Process
2+
3+
From http://FirstResponderKit.org
4+
5+
This doc explains how to do a release of the First Responder Kit scripts.
6+
7+
It's for internal use at BrentOzar.com, but other folks might find it useful.
8+
9+
Well, useful is probably the wrong word. More like entertaining. Here we go.
10+
11+
## Preparations
12+
13+
* Create a Milestone to tag issues/PRs as you work on them. In Github, go into Issues, Milestones (button at the top), and add a new milestone named YYYY-MM, like 2017-01.
14+
* As you merge pull requests into the dev branch (or before), tag them with the milestone. This makes it easy to find the related issues when you go to write release notes.
15+
16+
17+
## Finalize and Test the Code
18+
19+
* Make sure all issues in the milestone are closed - click Issues, Milestones, and it'll show the percent complete. If there's any issues you want to bump to the next round, add the next round's milestone and tag the issues with it.
20+
* When enough PRs are in dev, do a round of code testing in 2008-2016 in the cloud lab.
21+
* If it passes, bump all the version numbers inside the scripts.
22+
23+
## Push to Master
24+
25+
* Push to the master branch from dev. (Make sure you're pushing FROM dev, TO master.)
26+
* Draft a new release. Click Code, Releases, and edit one of the recent releases to get the Markdown syntax. Copy/paste that into a new release, and put the issue numbers for the relevant changes.
27+
* Publish the release pointing at the current master branch code (not dev).
28+
29+
## Announce It
30+
31+
* Copy the FRK scripts into BrentOzar.com's First Responder Kit zip file (Employees/Products/Download Pack)
32+
* Copy the old zip file's name, delete the old zip file, then create a new zip file with today's date, like First-Responder-Kit-20170126.zip.
33+
* Upload it to u.brentozar.com (s3), set permissions so that it's readable by everyone. Delete the old zip file.
34+
* Change the email download link by going into BrentOzar.com WordPress - click Forms, and in the form list, find First Responder Kit, Settings, Notifications, First Responder Kit. Edit the message to point to the new zip file name.
35+
* Copy the Github release text into a WordPress blog post. The nice thing about doing the Github release first is that you should be able to copy/paste the Github release page and the HTML should paste smoothly into the WordPress draft window, complete with links to the Github issues. At the end of the post, put a download now link that points to: https://www.brentozar.com/first-aid/
36+
* Create a Mailchimp announcement to people who subscribed to the FRK releases, linking directly to the zip file. (For now, Brent will do this part.)
37+

0 commit comments

Comments
 (0)