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

docs: new repo refs and build tweaks

Browse source
This commit is contained in:
Pat Cavit 2017-05-02 13:12:00 -07:00 • committed by GitHub
parent 3f70e183ef
commit 5660637e30
22 changed files with 424 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/releasing.md
View file

@ -1,5 +1,7 @@
# Mithril Release Processes
**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
### Prepare the release
@ -8,7 +10,7 @@
```bash
$ git co next
$ git pull --rebase lhorie next
$ git pull --rebase mithriljs next
```
2. Determine patch level of the change
@ -22,8 +24,8 @@ $ git commit -m "Preparing for release"
# Push to your branch
$ git push
# Push to lhorie/mithril.js
$ git push lhorie next
# Push to MithrilJS/mithril.js
$ git push mithriljs next
```
### Merge from `next` to `master`
@ -32,7 +34,7 @@ $ git push lhorie next
```bash
$ git co master
$ git pull --rebase lhorie master
$ git pull --rebase mithriljs master
```
6. merge `next` on top of it
@ -53,10 +55,10 @@ $ npm test
8. `npm run release <major|minor|patch|semver>`, 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`
10. Push the changes to `MithrilJS/mithril.js`
```bash
$ git push lhorie master
$ git push mithriljs master
```
11. Travis will push the new release to npm & create a GitHub release
@ -69,7 +71,7 @@ This helps to ensure that the `version` field of `package.json` doesn't get out
```bash
$ git co next
$ git pull --rebase lhorie next
$ git pull --rebase mithriljs next
```
13. Merge `master` back onto `next`
@ -78,11 +80,11 @@ $ git pull --rebase lhorie next
$ git merge master
```
14. Push the changes to your fork & `lhorie/mithril.js`
14. Push the changes to your fork & `MithrilJS/mithril.js`
```bash
$ git push
$ git push lhorie next
$ git push mithriljs next
```
### Update the GitHub release
@ -94,11 +96,11 @@ $ git push lhorie next
Fixes to documentation can land whenever, updates to the site are published via Travis.
```bash
# These steps assume that lhorie/mithril.js is a git remote named "lhorie"
# 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 pull lhorie next
$ git pull mithriljs next
# Splat the docs folder from next onto master
$ git co master
@ -106,7 +108,7 @@ $ git co next -- ./docs
# Manually ensure that no new feature docs were added
$ git push lhorie
$ git push mithriljs
```
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.