-
Notifications
You must be signed in to change notification settings - Fork 638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Please keep Changelog up to date #46
Comments
I agree. The interdependencies between modules and out-of-date modules can cause some strangeness. Besides keeping the changelog up-to-date, we should see if there is a way to detect incompatibilities at runtime when in development mode (might be a tooling issue). Perhaps something that could inspect the |
Thanks @philidem -- That sounds like it would be a big help! |
Hi @barwin. We do maintain a CHANGELOG.md for Marko: https://github.com/raptorjs/marko/blob/master/CHANGELOG.md However, I think an "Upgrade Guide" is needed as well to describe what steps should be taken to upgrade to a new major version. This would be similar to the "Upgrade Guide" added for Marko Widgets: https://github.com/raptorjs/marko-widgets/blob/master/CHANGELOG.md#upgrade-guide Any other suggestions for making the changelog better? |
I think the Marko ChangeLog was a bit out of date when I opened this issue, but it seems to be all caught up now. Thanks for that! (Or, I may just be crazy ...) Upgrade guides are definitely fantastic help, and much appreciated. It seems some supporting modules don't have ChangeLogs, however, and that's what I was trying to get at in my initial message. Here are a few, as examples: raptorjs/optimizer, raptorjs/optimizer-marko, raptorjs/optimizer-less. Maybe it wouldn't be practical or helpful to have Changelogs for each .. I'm not sure. As a Marko-user, it's probably easier to have a single ChangeLog/Upgrade guide to follow. But the interdependencies between modules complicates things. I like @philidem's suggestion of having some runtime detection of incompatibilities. Meanwhile, I'm using 'npm shrinkwrap' to freeze my module versions so that any future upgrades are deliberate and that is a working solution for me, for now. Thank you for the great project! -Ben |
* chore: add size tracking utility * chore: only build `runtime/dist/dom` for size * chore: add size check to ci
Especially with regards to breaking changes and feature deprecations.
It will help us make informed decisions about if/when to upgrade and what app-changes we need to make to stay up to date with the latest and greatest.
We have gotten ourselves into trouble a few times with mismatched versions between marko and supporting modules. I think having an accurate Changelog on each module would be hugely helpful in tracking down where we went awry.
Thanks!
The text was updated successfully, but these errors were encountered: