| 1 | ## What We're Doing
|
| 2 | The xplat CLI has a dependency on the Node SDK. In order to make sure that partners can easily keep their copies of the xplat CLI and Node SDK in sync, we need to finagle things a little as we get ready for release.
|
| 3 |
|
| 4 | ## At Code Complete
|
| 5 |
|
| 6 | At code complete, we do the following:
|
| 7 |
|
| 8 | ### Node SDK repository
|
| 9 | 1. Create a new branch off the dev branch named "release-<version>", where version is the release number for the new release. So as we work towards releasing version 0.6.10, the branch will be "release-0.6.10". All work as part of this release process will be done on this new branch.
|
| 10 |
|
| 11 | 2. Update the package.json file with the upcoming version number.
|
| 12 |
|
| 13 | 3. Update the change log.
|
| 14 |
|
| 15 | ### XPlat CLI repository
|
| 16 |
|
| 17 | 1. Create a new branch off the dev branch named "release-<version>", where version is the release number for the new release. So as we work towards releasing version 0.6.10, the branch will be "release-0.6.10". All work as part of this release process will be done on this new branch.
|
| 18 |
|
| 19 | 2. Update the package.json file to the new version of the CLI.
|
| 20 |
|
| 21 | 3. Update the package.json dependency on the azure sdk to point to the release branch for the sdk on github. This allows those testing the new CLI bits to get the correct SDK via "npm install" even though we haven't published the new SDK to npm yet.
|
| 22 |
|
| 23 | 4. Create the mac and windows installers and Linux tarball
|
| 24 |
|
| 25 | The entry in package.json looks like this:
|
| 26 |
|
| 27 | ```
|
| 28 | "dependencies": {
|
| 29 | "azure" : "git://github.com/WindowsAzure/azure-sdk-for-node.git#release-0.6.10",
|
| 30 | "xml2js" : "0.1.x",
|
| 31 | ```
|
| 32 |
|
| 33 | ### Both repositories
|
| 34 |
|
| 35 | 1. Send out email to partners saying the release is ready and how to get it.
|
| 36 |
|
| 37 | ## Stabilization
|
| 38 |
|
| 39 | This is the phase after code complete where everyone's banging on the bits, looking for (and probably finding) bugs.
|
| 40 |
|
| 41 | All issues will be fixed in the release branch of the appropriate repositories. We will decide if we need to rebuild packages and restart test passes on a case-by-case basis.
|
| 42 |
|
| 43 | ## Release
|
| 44 |
|
| 45 | After we've completed stabilization, we will do the following steps to do the release.
|
| 46 |
|
| 47 | 1. Publish azure SDK from the release branch to npm
|
| 48 | 2. Change the xplat-cli package.json azure dependency back to npm (with the new version number)
|
| 49 | 3. Rebuild xplat-cli packages (msi, mac installer, tarball), do smoke testing.
|
| 50 | 4. Publish xplat-cli module to npm, other channels
|
| 51 |
|
| 52 | ## Post Release
|
| 53 |
|
| 54 | After the release is done, we need to:
|
| 55 |
|
| 56 | 1. Add a git tag for the release commits in both repos.
|
| 57 | 2. Merge release branch into master
|
| 58 | 3. Merge master to dev
|
| 59 | 4. Delete release branch (we have the tag if we need to go back)
|
| 60 |
|
| 61 | And we're ready for the next go round.
|