Recommended revisions
Recommended revisions is a project to try to find a consensus-based listing of the ideal revision to use for any extension or skin, for different MediaWiki versions. Often, when deciding which extensions and skins to use with a specific wiki (or wiki farm, or MediaWiki package), the next most important decision is which exact version to use. The general advice is to use the revision associated with the Git branch for the MediaWiki version you are using, e.g. REL1_39. For certain extensions, it is recommended to use the latest released version, or simply the latest revision. However, it is hard to know what all the rules are, and for any particular extension or skin, the stated rule might not apply anyway.
Note that the "ideal" revision for any extension or skin is not one that is bug-free (since it is difficult or impossible to have truly bug-free software), and not even necessarily the revision that has the fewest bugs. Rather, it is the one that collectively MediaWiki users feel most confident about using. If some known bug is fixed in an extension, it does not necessarily mean that the recommended revision for that extension should jump to that newer one - since that bug fix, or any of the revisions immediately before it, could have introduced other bugs. So finding the ideal revision for a particular extension or skin may in some cases be the product of analysis and consensus.
For now, only MediaWiki LTS (long-term support) versions are supported, starting with MW 1.39. However, if someone wants to create a "best revisions" listing for another MediaWiki version, feel free. Be warned, though, that it takes a lot of work!
Every listing is done via a YAML file, where the extension/skin names (minus spaces) are the headers, and some subset of the parameters repository
, branch
and commit
are specified. Any such file should be read in the following way:
- If a
repository
value is set, use that; otherwise, use the expected location for that extension or skin in the Wikimedia Git repository, e.g. https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionName, or its mirror at https://github.com/wikimedia/mediawiki-extensions-ExtensionName. - If a
branch
value is set, use that; otherwise, ifrepository
is set, use themaster
branch; and if neither is set, use the version-specific branch (e.g.,REL1_39
) - Use the
commit
value, a hexadecimal string, to get the exact revision (this is mandatory)