Hello everyone,
It looks like Volker's e-mail, below, didn't get distributed by the list on Wednesday; re-sending now. With apologies.
---------- Forwarded message ---------- From: Volker Eckl volker@wikimedia.org Date: Wed, May 31, 2017 at 1:30 AM Subject: OOjs UI 0.22.0 release (breaking change) To: Wikimedia developers wikitech-l@lists.wikimedia.org
Hello everyone,
We've released OOjs UI 0.22.0, today. It will be in MediaWiki core from 1.30.0-wmf.4, which will be deployed to Wikimedia production in the regular train, starting on Tuesday 6 June. As there are three breaking changes in this release, at least nominally, please carefully consider if they affect your code.
Breaking changes since last release:
* TextInputWidget: Remove deprecated search related methods (Prateek Saxena) After being deprecated back in v0.18.0, we removed search related methods entirely. The TextInputWidget got slimmed down and a more specialized SearchInputWidget is available since November 2016. If you still use search methods, please switch over to SearchInputWidget.
* icons: Drop the deprecated core icon pack (James D. Forrester) Dropped 'core' icon pack, deprecated in v0.20.1 and already moved all of its icons to different, more clearly labelled, icon packs back then. Now removed entirely.
* icons: Remove unused 'bookmark' icon (Volker E.) The 'bookmark' icon has been added, but has never been used in production nor is it planned, so it got removed.
Deprecations since last release:
* Rename the 'MediaWiki' theme to 'WikimediaUI' (James D. Forrester) In order to clarify and simplify connection between the default theme's development focus on Wikimedia user interfaces and connected resources we've decided to rename it. Currently there's an alias for the old name, which should allow your software to work as is. Still, consider renaming your style and script references in the time being.
* WindowManager: Deprecate using `openWindow`/`closeWindow` returns as promises (Bartosz Dziewoński) The return value is now a WindowInstance object. Rather than using the "nested promises" to wait for window to open/close, you should instance use its properties (opening, opened, closing, closed) to wait for the given step of window lifecycle.
Additional details are in the full changelog[0]. If you have any further queries or need help dealing with breaking changes, please let me know. As always, a general set of library documentation is available on mediawiki.org[1], and there is some comprehensive generated code-level documentation and interactive demos hosted on doc.wikimedia.org[2].
[0] - https://phabricator.wikimedia.org/diffusion/GOJU/browse/master/History.md [1] - https://www.mediawiki.org/wiki/OOjs_UI [2] - https://doc.wikimedia.org/oojs-ui/master/
Best, Volker
-- Senior UX Engineer, Editing Wikimedia Foundation
volker.e [at] wikimedia | @Volker_E
Some extra notes on the more interesting breaking/deprecating changes:
Breaking changes since last release:
[...]
- icons: Drop the deprecated core icon pack (James D. Forrester)
Dropped 'core' icon pack, deprecated in v0.20.1 and already moved all of its icons to different, more clearly labelled, icon packs back then. Now removed entirely.
This affects a large number of extensions. James and I have been working on updating them on task T166730 [1], and all of the extensions in Wikimedia production are by today updated (or have patches awaiting review), but a few others still need updates. Feel free to help, especially for projects you maintain.
[1] https://phabricator.wikimedia.org/T166730
Deprecations since last release:
- Rename the 'MediaWiki' theme to 'WikimediaUI' (James D. Forrester)
In order to clarify and simplify connection between the default theme's development focus on Wikimedia user interfaces and connected resources we've decided to rename it. Currently there's an alias for the old name, which should allow your software to work as is. Still, consider renaming your style and script references in the time being.
MediaWiki has been updated for this and this is unlikely to affect your code, unless you hardcoded the theme name somewhere.
[Deprecations since last release:]
* WindowManager: Deprecate using `openWindow`/`closeWindow` returns as
promises (Bartosz Dziewoński) The return value is now a WindowInstance object. Rather than using the "nested promises" to wait for window to open/close, you should instance use its properties (opening, opened, closing, closed) to wait for the given step of window lifecycle.
This also affects a number of extensions, some in Wikimedia production. I've updated a few of them on task T166729 [2], but more remain; feel free to help, especially for projects you maintain. You will see deprecation warnings for the deprecated usage.
[2] https://phabricator.wikimedia.org/T166729
On Tue, Jun 6, 2017 at 1:04 AM, James Forrester jforrester@wikimedia.org wrote:
Hello everyone,
It looks like Volker's e-mail, below, didn't get distributed by the list on Wednesday; re-sending now. With apologies.
---------- Forwarded message ---------- From: Volker Eckl volker@wikimedia.org Date: Wed, May 31, 2017 at 1:30 AM Subject: OOjs UI 0.22.0 release (breaking change) To: Wikimedia developers wikitech-l@lists.wikimedia.org
Hello everyone,
We've released OOjs UI 0.22.0, today. It will be in MediaWiki core from 1.30.0-wmf.4, which will be deployed to Wikimedia production in the regular train, starting on Tuesday 6 June. As there are three breaking changes in this release, at least nominally, please carefully consider if they affect your code.
Breaking changes since last release:
- TextInputWidget: Remove deprecated search related methods (Prateek
Saxena) After being deprecated back in v0.18.0, we removed search related methods entirely. The TextInputWidget got slimmed down and a more specialized SearchInputWidget is available since November 2016. If you still use search methods, please switch over to SearchInputWidget.
- icons: Drop the deprecated core icon pack (James D. Forrester)
Dropped 'core' icon pack, deprecated in v0.20.1 and already moved all of its icons to different, more clearly labelled, icon packs back then. Now removed entirely.
- icons: Remove unused 'bookmark' icon (Volker E.)
The 'bookmark' icon has been added, but has never been used in production nor is it planned, so it got removed.
Deprecations since last release:
- Rename the 'MediaWiki' theme to 'WikimediaUI' (James D. Forrester)
In order to clarify and simplify connection between the default theme's development focus on Wikimedia user interfaces and connected resources we've decided to rename it. Currently there's an alias for the old name, which should allow your software to work as is. Still, consider renaming your style and script references in the time being.
- WindowManager: Deprecate using `openWindow`/`closeWindow` returns as
promises (Bartosz Dziewoński) The return value is now a WindowInstance object. Rather than using the "nested promises" to wait for window to open/close, you should instance use its properties (opening, opened, closing, closed) to wait for the given step of window lifecycle.
Additional details are in the full changelog[0]. If you have any further queries or need help dealing with breaking changes, please let me know. As always, a general set of library documentation is available on mediawiki.org[1], and there is some comprehensive generated code-level documentation and interactive demos hosted on doc.wikimedia.org[2].
[0] - https://phabricator.wikimedia.org/diffusion/GOJU/browse/master/History.md [1] - https://www.mediawiki.org/wiki/OOjs_UI [2] - https://doc.wikimedia.org/oojs-ui/master/
Best, Volker
-- Senior UX Engineer, Editing Wikimedia Foundation
volker.e [at] wikimedia | @Volker_E
James D. Forrester Lead Product Manager, Editing Wikimedia Foundation, Inc. jforrester at wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikimedia-l | @jdforrester _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
wikitech-l@lists.wikimedia.org