Page MenuHomePhabricator

Update documentation and changelog for the mwbot update
Closed, ResolvedPublic1 Estimated Story Points

Description

With the removal of mwbot, we need to update the documentation and add an upgrade document: what extensions/skins need to do to upgrade.

Acceptance Criteria

Details

Other Assignee
zeljkofilipin
Related Changes in Gerrit:

Event Timeline

Peter set the point value for this task to 1.
Peter moved this task from Ready to Refine to dek kvin 15 on the Test Platform board.
Peter edited projects, added Test Platform (dek kvin 15); removed Test Platform.

Changed the what needs to be changed in: https://docs.google.com/document/d/1upLGPHYvoa6DVJNSZffAleYnqTGySbYPk5O4vbEmTpA/edit?tab=t.0

When the code is merged and the doc is reviewed I'll update the wiki.

Changelog: With wdio-mediawiki 6.0 we replaced mwbot with internal code. The change was done in two step:

  1. mwbot was exposed in the API, meaning you as a user got hold of the mwbot instance. We want to get rid off that and not expose our implementation so it's easier in the future to change API backend. This change removed the exposed mwbot and made Api.js expose what's needed: https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1191296
  2. The next step removes the actual mwbot dependency and implements our own functionality to talk to the API (using built in NodeJS fetch). https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1193892

You can see can see what you need to do to upgrade to 6..0 if you used mwbot in https://gerrit.wikimedia.org/g/mediawiki/extensions/examples (lets create a task for adding tests that use the API that we upgrade with the release and then add it to the changelog/upgrade info).

Peter added a subscriber: zeljkofilipin.

@zeljkofilipin have a look at the document and the proposed changelog. Do you think we should explain the changes in details (how to call each function) or will an example as in T406979 be enough?

I think this is ok the way it is now. I'll update the docs when I released the new version.

Change #1198423 had a related patch set uploaded (by Phedenskog; author: Phedenskog):

[mediawiki/core@master] selenium: Update mwbot update example

https://gerrit.wikimedia.org/r/1198423

Change #1198423 merged by jenkins-bot:

[mediawiki/core@master] selenium: Update mwbot update example

https://gerrit.wikimedia.org/r/1198423