Skip to content
This repository was archived by the owner on Jul 9, 2019. It is now read-only.

Creating a Release Candidate

Drew Delianides edited this page Jun 25, 2017 · 3 revisions

Because we work on the app constantly and need to test things pretty regularly it's imperative that we have a good development cycle. In most cases we work on a two week sprint and our Product Owner needs to review and approve tasks as we complete them. The follow outlines the appropriate steps for creating and adding to a Release Candidate PR for deployment.

  • Note: you must have Github's hub tool installed for this to work. Following the installation instructions for your environment. You should also alias hub to git.

1. Create/Fetch the release candidate branch.

Use git fetch to get an existing branch or git checkout -b to create one. Name it something close to release-x-y-z where x-y-z adheres to semver.

2. git fetch if you haven't done it yet (just in case)

hub has a sub command called am. The command does several things behind the scenes to make your git life much easier. am will copy down and apply a git patch to your current branch while keeping the author information intact (there's also apply which does the same thing but adds the commits as unstaged changes). So the command will look something like:

$ git am https://github.com/NewSpring/Holtzman/pull/{PR#}

This applies all the changes/commits from the PR into your current branch. You should do this for each PR that needs to be included in this release.

3. Push the release branch

Shouldn't have to -f push unless someone has added files to the branch since you last pulled down any changes. Git should error in this scenario.

4. Create the PR

Since you already have hub installed you can still do this on the command line. And it looks something like this.

$ git pull-request -b <branch> // branch flag only needed if base branch isn't master

If you don't specify the -m flag to add a message then git will open the default editor for you to add a message. At least in Vim the first line in the window is the title and any lines after will be in the description. If this doesn't feel normal then you can still create a PR the old fashioned way on github.com.

5. Relax

Pretty easy right?

Clone this wiki locally