diff --git a/README.md b/README.md index a403e2a9..5d093447 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ The idea is that you should be able to replace `ember test` with `ember exam` an ### Note On Version `>0.7.0` -Starting with version `0.7.0`, Ember Exam provides an explicit interface to load its functionality. This is done to remove some "magic" from the system and takes a queue from the [changes in `ember-cli-qunit@0.4.0`](https://github.com/ember-cli/ember-cli-qunit#upgrading). +Starting with version `0.7.0`, Ember Exam provides an explicit interface to load its functionality. This is done to remove some "magic" from the system and takes a cue from the [changes in `ember-cli-qunit@0.4.0`](https://github.com/ember-cli/ember-cli-qunit#upgrading). ```js // test-helper.js diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..4dca37e9 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,45 @@ +# Release Process + +The following details how to perform a release for `ember-exam`. + +## Update Changelog + +First, we need to update the changelog using [`git-extras`](https://github.com/tj/git-extras). + +```bash +git changelog +``` + +Be sure to cleanup the changelog by removing merge commits or any commits that don't provide meaningful information. Then, commit the changes with the following message: + +```bash +git commit -am "Update changelog for vx.x.x" +``` + +## Tag A New Version + +Next, we need to tag the new version. We do this using the built in `npm` command: + +```bash +npm version x.x.x +``` + +Then, we push the new commits and tag to the repo: + +``` +git push origin master --tags +``` + +## Publish The New Version + +Almost there! We now publish the new version using: + +```bash +npm publish +``` + +## Update release notes + +Finally, publish the [release on GitHub](https://github.com/trentmwillis/ember-exam/releases) by drafting a new release. Use the changelog to populate the entry. + +And that's it! Congratulations!