Hey,
As you are probably aware of, it has been possible for some time now to install Composer compatible MediaWiki extensions via Composer.
Markus Glaser recently wrote an RFC titled "Extension management with Composer" [0]. This RFC mentioned that it is not possible for extensions to specify which version of MediaWiki they are compatible with. After discussing the problem with some people from the Composer community, I created a commit that addresses this pain point [1]. It's been sitting on gerrit getting stale, so some input there is appreciated.
[0] https://www.mediawiki.org/wiki/Requests_for_comment/Extension_management_wit... [1] https://gerrit.wikimedia.org/r/#/c/105092/
For your convenience, a copy of the commit message:
~~
Make it possible for extensions to specify which version of MediaWiki
they support via Composer.
This change allows extensions to specify they depend on a specific version or version range of MediaWiki. This is done by adding the package mediawiki/mediawiki in their composer.json require section.
As MediaWiki itself is not a Composer package and is quite far away from becoming one, a workaround was needed, which is provided by this commit.
It works as follows. When "composer install" or "composer update" is run, a Composer hook is invoked. This hook programmatically indicates the root package provides MediaWiki, as it indeed does when extensions are installed into MediaWiki. The package link of type "provides" includes the MediaWiki version, which is read from DefaultSettings.php.
This functionality has been tested and confirmed to work. One needs a recent Composer version for it to have an effect. The upcoming Composer alpha8 release will suffice. See https://github.com/composer/composer/issues/2520
Tests are included. Composer independent tests will run always, while the Composer specific ones are skipped when Composer is not installed.
People that already have a composer.json file in their MediaWiki root directory will need to make the same additions there as this commit makes to composer-json.example. If this is not done, the new behaviour will not work for them (though no existing behaviour will break). The change to the json file has been made in such a way to minimize the likelihood that any future modifications there will be needed.
Thanks go to @beausimensen (Sculpin) and @seldaek (Composer) for their support.
~~
I also wrote up a little blog post on the topic: http://www.bn2vs.com/blog/2014/02/15/mediawiki-extensions-to-define-their-me...
Cheers
-- Jeroen De Dauw http://www.bn2vs.com Don't panic. Don't be evil. ~=[,,_,,]:3 --
Anyone? Anyone? Bueller?
On Sat, Feb 22, 2014 at 12:10 PM, Jeroen De Dauw jeroendedauw@gmail.comwrote:
Hey,
As you are probably aware of, it has been possible for some time now to install Composer compatible MediaWiki extensions via Composer.
Markus Glaser recently wrote an RFC titled "Extension management with Composer" [0]. This RFC mentioned that it is not possible for extensions to specify which version of MediaWiki they are compatible with. After discussing the problem with some people from the Composer community, I created a commit that addresses this pain point [1]. It's been sitting on gerrit getting stale, so some input there is appreciated.
[0]
https://www.mediawiki.org/wiki/Requests_for_comment/Extension_management_wit... [1] https://gerrit.wikimedia.org/r/#/c/105092/
For your convenience, a copy of the commit message:
~~
Make it possible for extensions to specify which version of MediaWiki
they support via Composer.
This change allows extensions to specify they depend on a specific version or version range of MediaWiki. This is done by adding the package mediawiki/mediawiki in their composer.json require section.
As MediaWiki itself is not a Composer package and is quite far away from becoming one, a workaround was needed, which is provided by this commit.
It works as follows. When "composer install" or "composer update" is run, a Composer hook is invoked. This hook programmatically indicates the root package provides MediaWiki, as it indeed does when extensions are installed into MediaWiki. The package link of type "provides" includes the MediaWiki version, which is read from DefaultSettings.php.
This functionality has been tested and confirmed to work. One needs a recent Composer version for it to have an effect. The upcoming Composer alpha8 release will suffice. See https://github.com/composer/composer/issues/2520
Tests are included. Composer independent tests will run always, while the Composer specific ones are skipped when Composer is not installed.
People that already have a composer.json file in their MediaWiki root directory will need to make the same additions there as this commit makes to composer-json.example. If this is not done, the new behaviour will not work for them (though no existing behaviour will break). The change to the json file has been made in such a way to minimize the likelihood that any future modifications there will be needed.
Thanks go to @beausimensen (Sculpin) and @seldaek (Composer) for their support.
~~
I also wrote up a little blog post on the topic:
http://www.bn2vs.com/blog/2014/02/15/mediawiki-extensions-to-define-their-me...
Cheers
-- Jeroen De Dauw http://www.bn2vs.com Don't panic. Don't be evil. ~=[,,_,,]:3 -- _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
On 03/01/2014 01:24 PM, Rob Lanphier wrote:
Anyone? Anyone? Bueller?
Markus and I already made our opinion when he wrote the RFC and I indicated my willingness to merge Jeroen's commits. I was holding off for any on-list objections being raised
Unless anyone raises a concrete objection now, I think we should JFDI.
Mark.
wikitech-l@lists.wikimedia.org