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

s/mithril/mithril@next/g, add v1 docs link [skip ci] (#2368)

Browse source 
This should help point users to the correct version if they plan to
install the release candidate, and it should help users find the
existing docs for v1.
This commit is contained in:
Isiah Meadows 2019-02-02 11:01:51 -05:00 • committed by GitHub
parent 722a4f4af9
commit b91a10a233
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 27 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/releasing.md
View file

@ -19,7 +19,8 @@ $ git pull --rebase mithriljs 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`
4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable.
5. Commit changes to `next`
```
$ git add .
@ -34,20 +35,20 @@ $ git push mithriljs next
### Merge from `next` to `master`
5. Switch to `master` and make sure it's up to date
6. 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
7. merge `next` on top of it
```bash
$ git merge next
```
7. Clean & update npm dependencies and ensure the tests are passing.
8. Clean & update npm dependencies and ensure the tests are passing.
```bash
$ npm prune
@ -57,34 +58,34 @@ $ npm test
### Publish the release
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 `MithrilJS/mithril.js`
9. `npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version)
10. The changes will be automatically pushed to your fork
11. Push the changes to `MithrilJS/mithril.js`
```bash
$ git push mithriljs master
```
11. Travis will push the new release to npm & create a GitHub release
12. Travis will push the new release to npm & create a GitHub release
### Merge `master` back into `next`
This helps to ensure that the `version` field of `package.json` doesn't get out of date.
12. Switch to `next` and make sure it's up to date
13. Switch to `next` and make sure it's up to date
```bash
$ git checkout next
$ git pull --rebase mithriljs next
```
13. Merge `master` back onto `next`
14. Merge `master` back onto `next`
```bash
$ git merge master
```
14. Push the changes to your fork & `MithrilJS/mithril.js`
15. Push the changes to your fork & `MithrilJS/mithril.js`
```bash
$ git push
@ -93,7 +94,7 @@ $ git push mithriljs next
### Update the GitHub release
15. 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.
16. 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
@ -117,6 +118,8 @@ $ git push mithriljs
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.
**Note:** When updating the stable version with a release candidate out, ***make sure to update the index + navigation to point to the new stable version!!!***
## Releasing a new ospec version
1. Ensure your local branch is up to date