README

徽章

PageToGitHub

PageToGitHub，简称P2G，是一个MediaWiki扩展，用于自动将MediaWiki维基中的代码传输到GitHub。它最初由Luca Mauri构思和编写，用于在Wikitrek中使用：作为开源软件发布，希望对其他人也可能有用。

功能

要求

安装

安装此扩展的最简单方法是使用Composer：它将自动解决所有依赖关系并安装它们。

将以下示例中的require配置添加到mediawiki安装根目录下的composer.local.json中，或者如果尚不存在，则创建该文件

{
    "require": {
        "lucamauri/page-to-github": "~2.0"
    },
    "extra": {
        "merge-plugin": {
            "include": [
            ]
        }
    },
    "config": {
    }
}

在命令提示符中，在mediawiki安装根目录下运行Composer

composer install --no-dev

将以下代码添加到站点LocalSettings.php中其余扩展加载附近

wfLoadExtension('PageToGitHub');

在此行以下，添加以下配置参数，如配置部分中所述。

配置

在LocalSettigs.php文件中添加

$wgP2GAuthToken = 'GitHub-Token';
$wgP2GIgnoreMinor = true;
$wgP2GKeyword = 'Keyword';
$wgP2GAddKeyword = true;
$wgP2GNameSpace = 'Module';
$wgP2GOwner = 'Project-Or-Person';
$wgP2GRepo = 'Name-Of-Your-Repository';

$wgP2GAuthToken

用于认证和对存储库进行修改的GitHub令牌。您可以在GitHub账户的设置 > 开发者设置 > 个人访问令牌中生成一个。

$wgP2GIgnoreMinor

如果为空或设置为true，则如果标记为次要，则不会将修订版推送到GitHub。

$wgP2GKeyword

一个可选的关键字，用于检查页面。当存在时，P2G将不会上传包含关键字不在页面中的页面。如果省略此参数，P2G将上传上面指定的命名空间中的所有页面。

$wgP2GAddKeyword

一个可选的布尔参数：当设置为true时，在$wgP2GKeyword中定义的单词将添加到页面名称之前，以形成文件名。

$wgP2GNameSpace

P2G将仅上传属于此变量中指定的命名空间的页面。

$wgP2GOwner

存储库的所有者（人员或组织）

$wgP2GRepo

必须上传代码的存储库名称

故障排除

要读取详细的日志消息，您可以拦截名为PageToGitHub的日志组：例如，在LocalSetting.php中进行以下配置

$wgShowExceptionDetails = true;
$wgDebugLogGroups['PageToGitHub'] = "/var/log/mediawiki/PageToGitHub-{$wgDBname}.log";

文档

许可协议

GNU通用公共许可证，版本3

维护者

Luca Mauri

贡献者