docs: update with latest fixes (#2116)

This commit is contained in:
Pat Cavit 2018-04-12 00:11:11 -07:00 committed by GitHub
parent b9f65c2fdd
commit 6fb77b7771
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
28 changed files with 276 additions and 89 deletions

View file

@ -2,6 +2,10 @@
**Note** These steps all assume that `MithrilJS/mithril.js` is a git remote named `mithriljs`, adjust accordingly if that doesn't match your setup.
- [Releasing a new Mithril version](#releasing-a-new-mithril-version)
- [Updating mithril.js.org](#updating-mithriljsorg)
- [Releasing a new ospec version](#releasing-a-new-ospec-version)
## Releasing a new Mithril version
### Prepare the release
@ -9,7 +13,7 @@
1. Ensure your local branch is up to date
```bash
$ git co next
$ git checkout next
$ git pull --rebase mithriljs next
```
@ -33,7 +37,7 @@ $ git push mithriljs next
5. Switch to `master` and make sure it's up to date
```bash
$ git co master
$ git checkout master
$ git pull --rebase mithriljs master
```
@ -70,7 +74,7 @@ This helps to ensure that the `version` field of `package.json` doesn't get out
12. Switch to `next` and make sure it's up to date
```bash
$ git co next
$ git checkout next
$ git pull --rebase mithriljs next
```
@ -99,12 +103,12 @@ Fixes to documentation can land whenever, updates to the site are published via
# These steps assume that MithrilJS/mithril.js is a git remote named "mithriljs"
# Ensure your next branch is up to date
$ git co next
$ git checkout next
$ git pull mithriljs next
# Splat the docs folder from next onto master
$ git co master
$ git co next -- ./docs
$ git checkout master
$ git checkout next -- ./docs
# Manually ensure that no new feature docs were added
@ -112,3 +116,61 @@ $ git push mithriljs
```
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.
## Releasing a new ospec version
1. Ensure your local branch is up to date
```bash
$ git checkout next
$ git pull --rebase mithriljs next
```
2. Determine patch level of the change
3. Update `version` field in `ospec/package.json` to match new version being prepared for release
4. Commit changes to `next`
```
$ git add .
$ git commit -m "chore(ospec): ospec@<version>"
# Push to your branch
$ git push
# Push to MithrilJS/mithril.js
$ git push mithriljs next
```
### Merge from `next` to `master`
5. Switch to `master` and make sure it's up to date
```bash
$ git checkout master
$ git pull --rebase mithriljs master
```
6. merge `next` on top of it
```bash
$ git checkout next -- ./ospec
$ git add .
$ git commit -m "chore(ospec): ospec@<version>"
```
7. Ensure the tests are passing!
### Publish the release
8. Push the changes to `MithrilJS/mithril.js`
```bash
$ git push mithriljs master
```
9. Publish the changes to npm **from the `/ospec` folder**. That bit is important to ensure you don't accidentally ship a new Mithril release!
```bash
$ cd ./ospec
$ npm publish
```