Extension:ExtensionDistributor

MediaWiki 拡張機能マニュアル

ExtensionDistributor リリースの状態: 安定
実装	特別ページ
説明	拡張機能を www.mediawiki.org から配布できるようにする
作者	Tim Starling, Sam Reed, Chad Horohoe
最新バージョン	継続的な更新
互換性の方針	MediaWiki とともにリリースされるスナップショット。 master には後方互換性がありません。
MediaWiki	1.26+
データベースの変更	いいえ
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
パラメーター $wgExtDistDefaultSnapshot $wgExtDistCandidateSnapshot $wgExtDistPopularSkinList $wgExtDistListFile $wgExtDistAPIConfig $wgExtDistSnapshotRefs $wgExtDistGraphiteRenderApi $wgExtDistPopularExtList
使用するフック APIQuerySiteInfoGeneralInfo
Quarterly downloads	36 (Ranked 104th)
translatewiki.net で翻訳を利用できる場合は、ExtensionDistributor 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

ExtensionDistributor 拡張機能は、git リポジトリ内の拡張機能の .tar.gz スナップショットを作成して、それらを配布します。 www.mediawiki.org での使用を意図しています。 動作例は Special:ExtensionDistributor を参照してください。

インストール

• ダウンロードして、ファイルをextensions/フォルダー内のExtensionDistributorという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionDistributor
• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'ExtensionDistributor' );
  

•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

環境設定:

/**
 * Configuration for the API client to use
 *
 * Must have a 'class' key, can either be
 * "GithubExtDistProvider" or "GerritExtDistProvider"
 *
 * Common parameters:
 *  'apiUrl' - API url to use with $EXT and $REF variables
 *  'tarballUrl' - API url where tarballs are located
 *  'tarballName' - Expected filename of tarballs
 *  'proxy' - Proxy to use (optional)
 *
 * Github specific parameters:
 *  'token' - An OAuth token for authenticating requests
 *
 * Gerrit specific parameters:
 *  'repoListUrl' - API url to fetch a list of repositories
 *
 * @var array
 */
$wgExtDistAPIConfig = false;

/**
 * File to fetch list of extensions from, with one extension per line
 * Only needed for the Github provider
 * Example url: https://gerrit.wikimedia.org/mediawiki-extensions.txt
 */
$wgExtDistListFile = false;

/**
 * Supported branches/tags, master is the default (and shouldn't be removed)
 */
$wgExtDistSnapshotRefs = array(
	'master',
);

/**
 * Snapshot branch/tag to default to
 */
$wgExtDistDefaultSnapshot = 'master';

拡張機能が動作するには、いくつかの設定を行う必要があります。 ウィキメディアのGerritインスタンスの場合、次のようになります。

$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',
);

Gerrit のプロバイダーは独立した tarball ジェネレーターを必要とし、extdist.wmflabs.org で動作するソースコードは以下にあります: https://github.com/wikimedia/labs-tools-extdist