You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
s/mithril/mithril@next/g, add v1 docs link [skip ci] (MithrilJS#2368)
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.
Copy file name to clipboardexpand all lines: docs/installation.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ If you're new to Javascript or just want a very simple setup to get your feet we
18
18
### NPM
19
19
20
20
```bash
21
-
$ npm install mithril --save
21
+
$ npm install mithril@next --save
22
22
```
23
23
24
24
---
@@ -32,7 +32,7 @@ $ npm init --yes
32
32
33
33
2. install required tools
34
34
```bash
35
-
$ npm install mithril --save
35
+
$ npm install mithril@next --save
36
36
$ npm install webpack webpack-cli --save-dev
37
37
```
38
38
@@ -83,7 +83,7 @@ npm init --yes
83
83
Then, to install Mithril, run:
84
84
85
85
```bash
86
-
npm install mithril --save
86
+
npm install mithril@next --save
87
87
```
88
88
89
89
This will create a folder called `node_modules`, and a `mithril` folder inside of it. It will also add an entry under `dependencies` in the `package.json` file
@@ -206,7 +206,7 @@ Live reload is a feature where code changes automatically trigger the page to re
206
206
207
207
```bash
208
208
# 1) install
209
-
npm install mithril --save
209
+
npm install mithril@next --save
210
210
npm install budo -g
211
211
212
212
# 2) add this line into the scripts section in package.json
Copy file name to clipboardexpand all lines: docs/releasing.md
+15-12
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@ $ git pull --rebase mithriljs next
19
19
20
20
2. Determine patch level of the change
21
21
3. Update information in `docs/change-log.md` to match reality of the new version being prepared for release
22
-
4. Commit changes to `next`
22
+
4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable.
23
+
5. Commit changes to `next`
23
24
24
25
```
25
26
$ git add .
@@ -34,20 +35,20 @@ $ git push mithriljs next
34
35
35
36
### Merge from `next` to `master`
36
37
37
-
5. Switch to `master` and make sure it's up to date
38
+
6. Switch to `master` and make sure it's up to date
38
39
39
40
```bash
40
41
$ git checkout master
41
42
$ git pull --rebase mithriljs master
42
43
```
43
44
44
-
6. merge `next` on top of it
45
+
7. merge `next` on top of it
45
46
46
47
```bash
47
48
$ git merge next
48
49
```
49
50
50
-
7. Clean & update npm dependencies and ensure the tests are passing.
51
+
8. Clean & update npm dependencies and ensure the tests are passing.
51
52
52
53
```bash
53
54
$ npm prune
@@ -57,34 +58,34 @@ $ npm test
57
58
58
59
### Publish the release
59
60
60
-
8.`npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version)
61
-
9. The changes will be automatically pushed to your fork
62
-
10. Push the changes to `MithrilJS/mithril.js`
61
+
9.`npm run release <major|minor|patch|semver>`, see the docs for [`npm version`](https://docs.npmjs.com/cli/version)
62
+
10. The changes will be automatically pushed to your fork
63
+
11. Push the changes to `MithrilJS/mithril.js`
63
64
64
65
```bash
65
66
$ git push mithriljs master
66
67
```
67
68
68
-
11. Travis will push the new release to npm & create a GitHub release
69
+
12. Travis will push the new release to npm & create a GitHub release
69
70
70
71
### Merge `master` back into `next`
71
72
72
73
This helps to ensure that the `version` field of `package.json` doesn't get out of date.
73
74
74
-
12. Switch to `next` and make sure it's up to date
75
+
13. Switch to `next` and make sure it's up to date
75
76
76
77
```bash
77
78
$ git checkout next
78
79
$ git pull --rebase mithriljs next
79
80
```
80
81
81
-
13. Merge `master` back onto `next`
82
+
14. Merge `master` back onto `next`
82
83
83
84
```bash
84
85
$ git merge master
85
86
```
86
87
87
-
14. Push the changes to your fork & `MithrilJS/mithril.js`
88
+
15. Push the changes to your fork & `MithrilJS/mithril.js`
88
89
89
90
```bash
90
91
$ git push
@@ -93,7 +94,7 @@ $ git push mithriljs next
93
94
94
95
### Update the GitHub release
95
96
96
-
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.
97
+
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.
97
98
98
99
## Updating mithril.js.org
99
100
@@ -117,6 +118,8 @@ $ git push mithriljs
117
118
118
119
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.
119
120
121
+
**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!!!***
When loaded directly with a `<script>` tag (rather than required), the stream library will be exposed as `window.m.stream`. If `window.m` is already defined (e.g. because you also use the main Mithril script), it will attach itself to the existing object. Otherwise it creates a new `window.m`. If you want to use streams in conjunction with Mithril as raw script tags, you should include Mithril in your page before `mithril-stream`, because `mithril` will otherwise overwrite the `window.m` object defined by `mithril-stream`. This is not a concern when the libraries are consumed as CommonJS modules (using `require(...)`).
52
+
When loaded directly with a `<script>` tag (rather than required), the stream library will be exposed as `window.m.stream`. If `window.m` is already defined (e.g. because you also use the main Mithril script), it will attach itself to the existing object. Otherwise it creates a new `window.m`. If you want to use streams in conjunction with Mithril as raw script tags, you should include Mithril in your page before `mithril/stream`, because `mithril` will otherwise overwrite the `window.m` object defined by `mithril-stream`. This is not a concern when the libraries are consumed as CommonJS modules (using `require(...)`).
0 commit comments