Extension:ExtensionDistributor

Manuel des extensions MediaWiki

ExtensionDistributor État de la version : stable
Implémentation	Page spéciale
Description	Permet la distribution des extensions à partir de www.mediawiki.org
Auteur(s)	Tim Starling, Sam Reed, Chad Horohoe
Dernière version	mises à jour continues
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	1.26+
Modifie la base de données	Non
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: parcourir le dépôt (GitHub) relecture Gerrit du code historique Git des validations (commits) Télécharger le tarball source
Paramètres $wgExtDistDefaultSnapshot $wgExtDistCandidateSnapshot $wgExtDistPopularSkinList $wgExtDistListFile $wgExtDistAPIConfig $wgExtDistSnapshotRefs $wgExtDistGraphiteRenderApi $wgExtDistPopularExtList
Accroches utilisées APIQuerySiteInfoGeneralInfo
Traduire l’extension ExtensionDistributor sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension ExtensionDistributor génère les instantanés .tar.gz des extensions dans le répertoire Git et les distribue. L'utilisation est destinée à www.mediawiki.org. Voir Special:ExtensionDistributor pour comprendre le fonctionnement.

Installation

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé ExtensionDistributor dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionDistributor
  

• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'ExtensionDistributor' );
  

• Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Paramètres de configuration :

/**
 * Configuration pour l'utilisation du client de l'API
 *
 * doit avoir une clé de type 'class' 
 * peut valoir "GithubExtDistProvider" ou "GerritExtDistProvider"
 *
 * Paramètres communs :
 *  'apiUrl' - URL de l'API à utiliser avec les variables $EXT et $REF
 *  'tarballUrl' - URL de l'API où se trouvent les tarball
 *  'tarballName' - Nom du fichier attendu pour les tarball
 *  'proxy' - Proxy à utiliser (facultatif)
 *
 * Paramètres spécifiques de Github:
 *  'token' - jeton OAuth pour l'authentification des requêtes
 *
 * Paramètres spécifiques de Gerrit :
 *  'repoListUrl' - URL de l'API pour obtenir la liste de dépôts
 *
 * @var array
 */
$wgExtDistAPIConfig = false;

/**
 * Fichier contenant la liste des extensions à récupérer (une extension par ligne).
 * Nécessaire uniquement pour le fournisseur de Github
 * URL d'exemple: https://gerrit.wikimedia.org/mediawiki-extensions.txt
 */
$wgExtDistListFile = false;

/**
 * Branches et balises prises en charge; par défaut: master (ne pas supprimer)
 */
$wgExtDistSnapshotRefs = array(
	'master',
);

/**
 * Branche ou balise par défaut de l'instantané.
 */
$wgExtDistDefaultSnapshot = 'master';

Vous devrez initialiser quelques paramètres pour faire fonctionner l'extension. Pour l'instance Gerrit de Wikimedia, c'est similaire à :

$wgExtDistAPIConfig = array(
	'class' => \MediaWiki\Extension\ExtensionDistributor\Providers\GerritExtDistProvider::class,
	'apiUrl' => 'https://gerrit.wikimedia.org/r/projects/mediawiki%2F$TYPE%2F$EXT/branches',
	'tarballUrl' => 'https://extdist.wmflabs.org/dist/$TYPE/$EXT-$REF-$SHA.tar.gz',
	'tarballName' => '$EXT-$REF-$SHA.tar.gz',
	'repoListUrl' => 'https://gerrit.wikimedia.org/r/projects/?p=mediawiki/$TYPE/',
);

$wgExtDistSnapshotRefs = array(
	'master',
	'REL1_25',
);

Le fournisseur Gerrit a besoin d'un générateur de tarball indépendant, le code source de celui qui fonctionne sur extdist.wmflabs.org est disponible : https://github.com/wikimedia/labs-tools-extdist