diff options
author | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
---|---|---|
committer | Yaco <franco@reevo.org> | 2020-06-04 11:01:00 -0300 |
commit | fc7369835258467bf97eb64f184b93691f9a9fd5 (patch) | |
tree | daabd60089d2dd76d9f5fb416b005fbe159c799d /www/wiki/vendor/README.md |
first commit
Diffstat (limited to 'www/wiki/vendor/README.md')
-rw-r--r-- | www/wiki/vendor/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/www/wiki/vendor/README.md b/www/wiki/vendor/README.md new file mode 100644 index 00000000..01aca1d7 --- /dev/null +++ b/www/wiki/vendor/README.md @@ -0,0 +1,37 @@ +MediaWiki-Vendor +================ + +[Composer] managed libraries required or recommended for use with [MediaWiki]. +This repository is maintained for use on the Wikimedia Foundation production +and testing clusters, but may be useful for anyone wishing to avoid directly +managing MediaWiki dependencies with Composer. + + +Usage +----- + +Checkout this library into $IP/vendor using `git clone <URL>` or add the +repository as a git submodule using `git submodule add <URL> vendor` followed +by `git submodule update --init`. + + +Adding or updating libraries +---------------------------- + +0. Read the [documentation] on the process for adding new libraries. +1. Ensure you're using version 1.6.2 (or later. This keeps installed.json + alphasorted, making patches less likely to conflict, and diffs easier to + read) of composer via `composer --version`. +2. Edit the composer.json file to add/update the libraries you want to change. +3. Run `composer update --no-dev --ignore-platform-reqs` to download files and + update the autoloader. +4. Add all the new dependencies that got installed to composer.json as well, + so that everything has their version pinned. (You can look at the changes + in composer.lock or composer/installed.json to see what they are.) +5. Add and commit changes as a gerrit patch. +6. Review and merge changes. + + +[Composer]: https://getcomposer.org/ +[MediaWiki]: https://www.mediawiki.org/wiki/MediaWiki +[documentation]: https://www.mediawiki.org/wiki/Manual:External_libraries |