This page documents the steps needed to get MediaWiki extensions through the review process before possibly being deployed to Wikimedia wikis. Anything that is deployed on the Wikimedia cluster needs to be reviewed for security and scalability issues. Where the word "extension" appears below, "skin" or "code" is synonymous.
Writing an extension for deployment can be a time-consuming project; any interested party is encouraged to start the process long before any deadline.
Once an extension has made it through reviews, then the extension can be scheduled for deployment by the Wikimedia Foundation Release Manager.
General prerequisites and expectations
- General: Follow the general guidelines and recommendations on writing extensions. Read Coding conventions, Pre-commit checklist, Performance guidelines, and Security for developers and make sure that your code follows these guidelines.
- Create an
Extension:My Extensionpage in the Extension: namespace on mediawiki.org to document for developers and people who will install or configure the extension. Use Template:Extension for this. You may use the field below to assist you with it.
- Create a
Help:Extension:My Extensionpage in the
Help:Extension:namespace on mediawiki.org for your extension's end-user documentation. Cross-link it with the
Extension:My Extensionpage above. Also see Manual:Developing extensions#Help documentation. Example: Help:VisualEditor/User guide. Screencasts can be useful in explaining how things work. You may use the field below to assist you with it.
- Create an
- Code hosting: Request a new Git/Gerrit repository to store the source code for your extension. Gerrit is where all code review will happen.
- Issue tracking: Request a project in Phabricator to track bugs and feature requests for your extension. Get notified of new tasks reported in your project.
- Localization: Your extension will need to be translated on translatewiki.net before it can be deployed anywhere. This requires your code to have proper i18n files etc.
- Gating deployment and feature flags: The Wikimedia Foundation runs nearly a thousand wikis in hundreds of languages. When we deploy code on our cluster, we enable extensions on a wiki-by-wiki basis and often configure them differently for each one. Extensions should have feature flags (e.g.,
wgMaxGeoSearchRadius) for turning particular behavior on and off or configuring some part of the extension, where that makes sense. When extensions are deployed, they will be gated behind a Wikimedia-specific global configuration variable such as
wmgUseEventLogging. This allows the extension to be deployed on a subset of wikis (for example, test and test2) without affecting all wikis. You can search through the existing very large CommonSettings.php and InitialiseSettings.php for reference.
- Database schema: See Development policy#Database patches. If your code requires a schema change (e.g. a new column on an existing table) either for core or an extension, keep in mind the schema change may happen only years later on the Wikimedia cluster. If at all possible, avoid schema changes.
- Compatibility: Your extension must be compatible with all extensions deployed on the Wikimedia cluster. See #Compatibility with other deployed extensions below for specific issues.
- Hosting a test version: Cloud VPS projects can be used to host test wikis with your extension installed for testing and demonstrations. See the Cloud Services Getting Started guide for more information.
- Add your extension to Developers/Maintainers and indicate who the maintainers are.
- Get initial code reviews: Try to get some trusted and established MediaWiki developers to follow your project in Gerrit and to look over your code and point out any flaws in it. If you do not have any particular developers in mind, ask in IRC or on the developers' mailing lists. Tell them you're following this guide so they can look for things that would block deployment.
Once above steps are done, consider getting community support for your idea:
- Community support can be shown by having an active discussion on the need of the extension on a wiki and documenting the responses. If there is no active community support, support can be built through discussions and proposals.
- Post your idea to the wikitech-l mailing list to get feedback from experienced developers and Wikimedians. People may point you to another extension that is already in use whose functionality duplicates what you want, or could be easily extended to do what you want. In that case, you should use Git to work on the extension that is already in use.
- Communicate your ideas and plans to affected wikis to garner both support, suggestions, and other feedback.
If you have followed the advice above and the feedback given by early reviewers closely, you probably won't have too much of a problem with the next steps.
Preparing for deployment
- The production deployment tracking task:
- Create a task in Phabricator (in the #Wikimedia-Extension-setup and #Wikimedia-Extension-Review-Queue projects) to get an extension into the review queue. This task should only concern deployment itself. Any issues which block deployment should be separate subtasks (listed under "Task Graph") that block this parent task.
- Your deployment tracking bug should point to on-wiki community consensus (and/or community support/desire) for having the extension installed on a particular wiki, if applicable.
- Good practice: Make the below reviews easier and faster for the reviewers by creating a MW-Vagrant role for the extension.
- Request and incorporate feedback the needed reviews: (you can include these as a "checklist" in the tracking task's description, e.g. phab:T190716)
- A security review: Open a security review task and mark it as a subtask of the main deployment task
- A product review, if applicable
- A design review, if applicable.
- A beta feature review, if your extension adds a beta feature.
- If you have reasons to think that a database review is needed, create a request in Phabricator.
- Any serious issues identified in these reviews must be addressed before deploying your code.
- After the security review, request deployment to the Beta Cluster (this can aid the other reviews). See #Deploy to Beta Cluster below for more information.
- Make sure the extension is automatically branched by make-wmf-branch.
- Request a date/time for deployment in the deployment tracking task to get it added to the deployment calendar.
- "You" (the person or persons driving/requesting this) will need to be online (on IRC in ) and available during the deployment to respond to any issues that might arise.
Compatibility with other deployed extensions
As written above, your extension must be compatible with all extensions deployed on the Wikimedia cluster. Specific issues follow.
- Renameuser and UserMerge
- If your extension has a database table that stores usernames, it needs to respond to the
RenameUserSQLhook to add its tables. If your extension is storing user IDs or usernames, it needs to respond to one or both of the
UserMergeAccountFieldshooks to update its tables accordingly. See hooks.txt.
- If your extension makes edits to pages, you need to consider whether it should do this on Flow boards and Flow topics, and handle them specially. For example, the MassMessage extension can post a message on a Flow-enabled user talk page.
Deploy to Beta Cluster
Before enabling a new extension in production, it can be tested on the Beta Cluster. To do this:
- Add the new extension submodule to the git mediawiki/extensions repo if it's not already in it. Alternately, you can plan ahead and add your extension to make-wmf-branch/config.json and it will automatically pick up the submodule (when the train cycle begins) without you having to add it manually.
- Require and configure the new extension. Beta Cluster uses the same wmf-config directory in the operations/mediawiki-config repository as production, but in addition Beta Cluster servers load
CommonSettings-labs.phpfiles so you can have settings that only apply to Beta Cluster. Read more about these config files). When testing on Beta Cluster before production, these can override
wgUseMyExtension, setting it to true on one or more Beta Cluster wikis. (Once your extension is in use in the production wiki(s) corresponding to Beta Cluster, you can probably remove the
- Here's the steps required to deploy a typical new extension to production (if your extension has more steps/dependencies, say Wikibase, make sure to check with someone before you deploy):
- Add your extension to
extension-list. See example.
- Add your extension config variable to
InitialiseSettings.phpand set it to be default false. See example.
- Add your extension config variable (same as in previous step) to
InitialiseSettings-labs.phpand set it to be true on beta cluster wikis you want it to be on. You may want to turn it off for loginwiki (which doesn't have most extensions). See example.
- Load your extension in
CommonSettings.php. See example.
- Add your extension to
It is possible to deploy extensions that do not exist in production to the Beta Cluster. However, the Beta Cluster runs code only from the master branch in Git. You should merge code into the master branch early and often in order to exercise that code as fully as possible on the Beta Cluster before it goes out to the general public. If you have specific questions about using the Beta Cluster, you can e-mail the Quality Assurance mailing list or ask in on IRC.
Skins follow the same process (but in mediawiki/skins) repository.
- Review queue project
- Requests for comment – a place for discussion of large project ideas for MediaWiki
- wikitech:How to deploy code#Case 1d: new extension – details of deploying a new extension on the Wikimedia cluster
- Requesting wiki configuration changes and Limits to configuration changes