From 05990024e1913863e3f22ad97d03b886f0cf41e4 Mon Sep 17 00:00:00 2001 From: Pat Cavit Date: Tue, 11 Apr 2017 11:17:25 -0700 Subject: [PATCH] docs: flesh out releasing process further --- docs/releasing.md | 46 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/docs/releasing.md b/docs/releasing.md index 7a9cbe3c..a137e1d0 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -4,19 +4,44 @@ ### Prepare the release -1. Determine patch level of the change -2. Update information in `docs/change-log.md` to match reality & the new version that will be released +1. Ensure your local branch is up to date + +```bash +$ git co next +$ git pull --rebase lhorie next +``` + +2. Determine patch level of the change +3. Update information in `docs/change-log.md` to match reality of the new version being prepared for release +4. Commit changes to `next` + +``` +$ git add . +$ git commit -m "Preparing for release" + +# Push to your branch +$ git push + +# Push to lhorie/mithril.js +$ git push lhorie next +``` ### Merge from `next` to `master` -3. Switch to `master` and merge `next` on top of it +5. Switch to `master` and make sure it's up to date ```bash $ git co master +$ git pull --rebase lhorie master +``` + +6. merge `next` on top of it + +```bash $ git merge next ``` -4. Clean & update npm dependencies and ensure the tests are passing. +7. Clean & update npm dependencies and ensure the tests are passing. ```bash $ npm prune @@ -26,12 +51,19 @@ $ npm test ### Publish the release -5. `npm run release `, see the docs for [`npm version`](https://docs.npmjs.com/cli/version) -6. Travis will push the new release to npm & create a GitHub release +8. `npm run release `, see the docs for [`npm version`](https://docs.npmjs.com/cli/version) +9. The changes will be automatically pushed to your fork +10. Push the changes to `lhorie/mithril.js` + +```bash +$ git push lhorie master +``` + +11. Travis will push the new release to npm & create a GitHub release ### Update the GitHub release -7. The GitHub Release will require a manual description & title to be added. I suggest coming up with a fun title & then copying the `docs/change-log.md` entry for the build. +12. The GitHub Release will require a manual description & title to be added. I suggest coming up with a fun title & then copying the `docs/change-log.md` entry for the build. ## Updating mithril.js.org