vndb/mithril-vndb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: flesh out releasing process further

Browse source
This commit is contained in:
Pat Cavit 2017-04-11 11:17:25 -07:00 • committed by GitHub
parent b718ae6f32
commit 05990024e1
1 changed files with 39 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/releasing.md
View file

@ -4,19 +4,44 @@
### Prepare the release ### Prepare the release
1. Determine patch level of the change 1. Ensure your local branch is up to date
2. Update information in `docs/change-log.md` to match reality & the new version that will be released
```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` ### 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 ```bash
$ git co master $ git co master
$ git pull --rebase lhorie master
```
6. merge `next` on top of it
```bash
$ git merge next $ 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 ```bash
$ npm prune $ npm prune
@ -26,12 +51,19 @@ $ npm test
### Publish the release ### Publish the release
5. `npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version) 8. `npm run release <major|minor|patch|semver>`, 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 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 ### 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 ## Updating mithril.js.org