Manual:External libraries/zh

From mediawiki.org
This page is a translated version of the page Manual:External libraries and the translation is 0% complete.

This page documents how to add new external libraries to MediaWiki core. We use composer to manage dependencies.

  1. Find your external library.

It should be available on packagist, and have a tagged release that you wish to use.

  1. Use this Phabricator form to request a security review of the library.

Security reviews are required for any externally-written code (not by a MediaWiki developer). Security review requests are prioritized on a quarterly basis per this section of the relevant SOP. This checklist will be used as a basic set of best practices when reviewing all third-party code. Please add the MediaWiki-Vendor project to the task.

  1. Once the security review is approved, submit a patch to the mediawiki/vendor repository, adding the library.
  1. Your patch should use fixed version numbers (e.g. 1.0.0) so we always use a specific version of the library instead of depending upon the upstream maintainer to properly follow the semantic versioning rules as many don't.
  1. Upload your mediawiki/core patchset which uses the library and include a link to your mediawiki/vendor commit in the comments.

(This step can be done earlier, but can't be merged until the security review is complete.)

  1. You will also need to update core's composer.json file in your patch

(using a fixed version number)

  1. Go through the normal code review process.

Once your code is ready for merging, the mediawiki/vendor patch should be merged, and then the mediawiki/core patch, so unit tests will be able to use the library.

For Wikimedia-deployed extensions, the process is similar.

You will need to create a composer.json file for your extension listing your dependencies. In your extension.json file, set "load_composer_autoloader": true, (documentation) so those dependencies are loaded.

The extension distributor automatically packages composer dependencies, so tarball users won't have to do it manually. You'll then need to add the library to the mediawiki/vendor repository after the security review is complete.

See also