Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.37 KB

RELEASE.md

File metadata and controls

66 lines (55 loc) · 2.37 KB
Raw

Release

Although not very tricky, it is quite easy to deploy something that doesn't quite work as expected. The following steps navigate a through some of the release gotchas and will hopefully result in a successful release.

STEPS:

  1. let other contributors know that you are preparing a release and to hold off on merging PRs or pushing new code
  • ensure you using the latest stable node and iojs (but not v0.13.x for now) as it has a broken zlib which causes it to publish corrupted modules)
  • run ./bin/changelog and add output to CHANGELOG.md
  • edit changelog output to be as user-friendly as possible (drop [INTERNAL] changes etc.)
  • bump package.json version
  • ./bin/prepare-release
  • cd to/someplace/to/test/
  • ensure ember version is the newly packaged version
  • ensure new project generation works ember new --skip-npm my-cool-test-project
  • fixup deps: cd my-cool-test-project
  • link your local ember-cli npm link ember-cli
  • install other deps: npm i && bower i
  • test the server: ember s
  • test other things like generators and live-reload
  • generate a http mock ember g http-mock my-http-mock
  • test upgrades of other apps

If everything went well, release:

Please note, we have must have an extremely low tolerance for quirks and failures we do not want our users to endure any extra pain.

  1. go back to ember-cli directory
  • git add the modified package.json and CHANGELOG.md
  • Commit the changes git commit -m "Release vx.y.z" and push git push
  • git tag "vx.y.z"
  • git push origin <vx.y.z>
  • publish to npm
    • if normal release
      • npm publish ./ember-cli-<version>.tgz
    • if beta release
      • npm publish ./ember-cli-<version>.tgz --tag beta

Test published version

  1. npm uninstall -g ember-cli
  • npm cache clear
  • npm install -g ember-cli
  • ensure version is as expected ember version
  • ensure new project generates
  • ensure old project upgrades nicely

Tag the release

  1. Under Releases on GitHub choose Draft New Release
  • enter the new version number as the tag prefixed with v e.g. (v0.1.12)
  • for release title choose a great name, no pressure
  • in the description paste the upgrade instructions from the previous release, followed by the new CHANGELOG entry
  • publish the release

Update the site

  1. check out ember-cli/ember-cli.github.io
  • update _config.yml version
  • update _posts/2012-01-01-changelog.md