Creating a new release

In this document, we'll cover:

• 1. Update Foundation (if needed)
• 2. Create a release commit
• 3. Merge develop into master
• 4. Update Bower dependencies (optional)
• 5. Tag the new release
• 6. Push to Github and edit the release page
• 7. Deploy the new release
• 8. Communication

---

All development should occur in the develop branch. When you're ready to create a new release, follow these instructions starting from the develop branch.

1. Update Foundation (if needed)

If changes to the develop branch include any Foundation updates, first create a new release of Foundation. Framework releases should always reference a stable tag of Foundation.

The develop branch of the Framework is referencing the develop branch of Foundation. After you've created the Foundation release you can run bower update to pull in those changes to the Framework prior to release. This ensures that the generated stylesheets and javascripts are current with the latest Foundation release.

2. Create a release commit

Update the version number in package.json, run grunt version and grunt build and add a section in CHANGELOG.md describing changes introduced by this release.

The following files should show changes:

• CHANGELOG.md
• css-dev/style.scss
• functions.php
• ie.css
• ie.min.css
• package.json
• style.css
• style.min.css

Stage all changes and commit using "Version bump to x.x.x" as the commit message.

3. Merge develop into master

In the left panel under "Branches" checkout the master branch and then click and drag develop on top of master to merge. Make sure that "Always generate a merge commit" is checked.

4. Update Bower dependencies (optional)

If you created a Foundation release above, now's the time to update bower.json to point to the shiny new stable tag and run bower install to update bower_components. Create a commit with these changes (e.g. "Version bumps in bower.json").

5. Tag the new release

In the left panel under "Branches" right-click on the master branch and select "Create new tag from "master"...". Enter the tag number and a simple message ("Release x.x.x.").

6. Push to Github and edit the release page

Push the master branch to Github and curate the resulting entry in the releases page (https://github.com/bu-ist/responsive-framework/releases). When pushing, make sure that "Push All Tags" is checked under "Options". If you forget, you can always right-click on the tag and click "Publish Tag".

7. Deploy the new release

Deploy the new release to NM sandbox and production using WP Deploy. Make sure to select the latest tag in WP Deploy.

8. Communication

Paste the release link in Slack (#cms) using @channel (e.g. https://github.com/bu-ist/responsive-framework/releases/tag/1.0.1).