Runtime-deprecate ospec, change change-log to changelog, fix a few assorted bugs (#2578)
This commit is contained in:
Isiah Meadows
GitHub
parent
1630b06106
commit
9f0dc2ab46
76 changed files with 484 additions and 410 deletions
|
|
@ -9,8 +9,8 @@
|
|||
- [v1.x changelog](https://mithril.js.org/archive/v1.1.7/change-log.html)
|
||||
- [v1.x docs](https://mithril.js.org/archive/v1.1.7/index.html)
|
||||
- [v0.2 docs](https://mithril.js.org/archive/v0.2.5/index.html)
|
||||
- [`ospec` change log](https://github.com/MithrilJS/mithril.js/blob/master/ospec/change-log.md)
|
||||
- [`mithril/stream` change log](https://github.com/MithrilJS/mithril.js/blob/master/stream/change-log.md)
|
||||
- [`ospec` change log](https://github.com/MithrilJS/ospec/blob/master/changelog.md)
|
||||
- [`mithril-stream` change log](#mithril-stream-change-log)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -20,6 +20,8 @@
|
|||
|
||||
*Note for later: release as semver-minor.*
|
||||
|
||||
PSA: changes to [`mithril/stream`](stream.md) are now specified in this changelog. I've also moved the old stream changelog into this file [here](#mithril-stream-change-log).
|
||||
|
||||
- Reduced package download size substantially by removing the archive of previous releases' documentation. ([#2561](https://github.com/MithrilJS/mithril.js/pull/2561) [@cztomsik](https://github.com/cztomsik))
|
||||
- Improved error messages in multiple places. ([#2536](https://github.com/MithrilJS/mithril.js/pull/2536) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- The redraw reentrancy check was moved from `m.mount` to `m.render` and its error message was updated accordingly. ([#2536](https://github.com/MithrilJS/mithril.js/pull/2536) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
|
|
@ -31,6 +33,9 @@
|
|||
- Re-add stream bundles. ([#2539](https://github.com/MithrilJS/mithril.js/pull/2539) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- Remove extra isLifecycleMethod call from removeAttr. ([#2594](https://github.com/MithrilJS/mithril.js/pull/2594) [@ZeikJT](https://github.com/zeikjt))
|
||||
- Fix issue where ending a stream in the middle of a stream callback would result in erroneous parent stream state for the rest of that emit. ([#2603](https://github.com/MithrilJS/mithril.js/pull/2603) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- Fix issue where new redraw handlers weren't copied over on update. ([#2578](https://github.com/MithrilJS/mithril.js/pull/2578) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- Make changes to file inputs gracefully handled, and don't break if the current value and old value mismatch (and the new value isn't empty), but instead just log an error. ([#2578](https://github.com/MithrilJS/mithril.js/pull/2578) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- This mainly exists just to kick the can down the road - this is the only case I'm aware of where the DOM itself would be responsible for throwing an error. A proper fix to the greater issue of error handling is much more complex, and I'd rather not block users any longer over this one specific issue.
|
||||
|
||||
Important note: if you were using any of these undocumented tools, they are no longer available as of this release. This is not considered a breaking change as they were written for internal usage and as of v2 are all 100% unsupported in userland.
|
||||
|
||||
|
|
@ -181,3 +186,22 @@ _2019-07-24_
|
|||
- docs: clarify valid key usage ([#2452](https://github.com/MithrilJS/mithril.js/pull/2452) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- route: don't pollute globals ([#2453](https://github.com/MithrilJS/mithril.js/pull/2453) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
- request: track xhr replacements correctly ([#2455](https://github.com/MithrilJS/mithril.js/pull/2455) [@isiahmeadows](https://github.com/isiahmeadows))
|
||||
|
||||
## `mithril-stream` change log
|
||||
|
||||
Formerly, `mithril/stream` was available standalone as the package `mithril-stream`, but this package has been deprecated and is no longer updated. The changelog for that package prior to being merged back into Mithril proper is below.
|
||||
|
||||
### 2.0.0
|
||||
_2019-02-07_
|
||||
|
||||
- when a stream conditionally returns HALT, dependant stream will also end ([#2200](https://github.com/MithrilJS/mithril.js/pull/2200), [#2369](https://github.com/MithrilJS/mithril.js/pull/2369))
|
||||
- Add `stream.lift` as a user-friendly alternative to `merge -> map` or `combine` ([#1944](https://github.com/MithrilJS/mithril.js/issues/1944))
|
||||
- renamed HALT to SKIP ([#2207](https://github.com/MithrilJS/mithril.js/pull/2207))
|
||||
- rewrote implementation ([#2207](https://github.com/MithrilJS/mithril.js/pull/2207))
|
||||
- Removed `valueOf` & `toString` methods ([#2150](https://github.com/MithrilJS/mithril.js/pull/2150))
|
||||
- fixed `stream.end` propagation ([#2369](https://github.com/MithrilJS/mithril.js/pull/2369))
|
||||
|
||||
### 1.1.0
|
||||
_2017-07-13_
|
||||
|
||||
- Move the "use strict" directive inside the IIFE [#1831](https://github.com/MithrilJS/mithril.js/issues/1831) ([#1893](https://github.com/MithrilJS/mithril.js/pull/1893))
|
||||
|
|
@ -25,6 +25,6 @@
|
|||
- [Code of Conduct](code-of-conduct.md)
|
||||
- Misc
|
||||
- [Framework comparison](framework-comparison.md)
|
||||
- [Change log/Migration](change-log.md)
|
||||
- [Change log/Migration](changelog.md)
|
||||
- [v1 Documentation](https://mithril.js.org/archive/v1.1.7/)
|
||||
- [v0.2 Documentation](https://mithril.js.org/archive/v0.2.5/)
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@
|
|||
|
||||
- [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
|
||||
|
||||
|
|
@ -18,7 +17,7 @@ $ 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.
|
||||
3. Update information in `docs/changelog.md` to match reality of the new version being prepared for release.
|
||||
- Don't forget to add today's date under the version heading!
|
||||
4. Replace all existing references to `mithril@next` to `mithril` if moving from a release candidate to stable.
|
||||
- Note: if making an initial release candidate, don't forget to move all the playground snippets to pull from `mithril@next`!
|
||||
|
|
@ -96,11 +95,11 @@ $ git push mithriljs next
|
|||
|
||||
### Update the GitHub release
|
||||
|
||||
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.
|
||||
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/changelog.md` entry for the build.
|
||||
|
||||
## Updating mithril.js.org
|
||||
|
||||
Fixes to documentation can land whenever, updates to the site are published via Travis.
|
||||
Fixes to documentation can land whenever, updates to the site are built and published via `scripts/update-docs.js`.
|
||||
|
||||
```bash
|
||||
# These steps assume that MithrilJS/mithril.js is a git remote named "mithriljs"
|
||||
|
|
@ -115,69 +114,9 @@ $ git checkout next -- ./docs
|
|||
|
||||
# Manually ensure that no new feature docs were added
|
||||
|
||||
$ git push mithriljs
|
||||
$ node scripts/update-docs
|
||||
```
|
||||
|
||||
After the Travis build completes the updated docs should appear on https://mithril.js.org in a few minutes.
|
||||
After the docs 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
|
||||
|
||||
```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. Update `ospec/change-log.md` to match new version being prepared for release.
|
||||
- Don't forget to add today's date under the version heading!
|
||||
5. 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
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue