深入Matomo

维护插件

Matomo核心-维护插件

本指南适用于Matomo核心开发者。如果你开发了一个插件，并想以贡献者的身份分享它，请查看指南分发插件．

如何添加一个新的插件

  • 遵循内部流程创建一个新的GitHub存储库下创建一个新的github存储库matomo-org．插件的名称通常以插件,后面跟着插件名。例如，你可以在我们松弛的时候ping我们。我们使用* .x-dev作为主要分支在哪里＊将被Matomo的最新主版本所取代。
    • 创建存储库之后，我们还应该对其进行配置，以便进行转换Weblate．为了做到这一点，
    • 进入存储库设置-> Webhooks
    • 创建一个webhookhttps://hosted.weblate.org/hooks/github/作为有效负载URL
    • 用这个插件库在webate上创建一个组件
  • 推送代码
  • 将插件的存储库作为子模块添加到我们的主matomo存储库中Git子模块添加{http-plugin-github-address} plugins/{pluginname}
  • 编辑.gitmodules并将该子模块的条目移动到底部的注释之前(参见注释的描述)
  • 预计一些核心截图会失败，一些集成或系统测试也会失败，因为插件将被激活，对这个插件的测试也会在核心测试期间运行。这是因为我们认为与内核绑定的插件需要经常测试(在每个matomo更改上测试兼容性)。否则，测试只会在插件更改时运行，即使核心的更改可能会导致问题。
  • 在Manage -> Access中，给予“核心团队”和“插件审阅者”团队写权限。添加“产品管理”，并给予其分类访问权限。
  • 在Manage ->中，分支保护分支* .x-dev并且只允许“插件评审员”团队合并到这些分支中。

Github测试

去Matomo-org的秘密然后改变ARTIFACTS_PASSSecret，以允许存储库访问此秘密。要做到这一点，请按照以下步骤对每个秘密:

  • 点击编辑图标
  • 单击齿轮图标
  • 找到这个插件/特性的存储库并启用它
  • 点击“更新选择”
  • 点击“保存更改”

新插件清单

  • 新插件有一个许可证类似于https://github.com/matomo-org/plugin-QueuedTracking/blob/5.x-dev/LICENSE的文件
  • 中也定义了相同的许可证plugin.json
  • 中配置描述性描述和有用的关键字plugin.json．插件JSON文件中的其他值也是如此。
  • 类型中定义了任何可能的屏幕截图截图文件夹中。
  • 如果文档/ index.md或文档/ faq.md是不需要的，那就删除它们

开发一个高级插件

  • 克隆你想要处理的插件到插件文件夹中。使用插件名作为文件夹:plugin_SomeName->SomeName
  • 创建(或更新如果您已经拥有)一个.gitignore在你的插件文件夹并添加新文件夹。这.gitignore文件在主程序中已经被忽略.gitignore
  • 在管理仪表板上激活插件，系统>插件页面
  • 你可以在这个插件文件夹中创建分支，pr
  • 要为Github动作测试配置插件，请参阅内部文档中描述的步骤构建并启动一个新的高级插件．

维护插件常见问题

我怎么让特拉维斯使用LFS?

为了让travis正确地签出截图并使用LFS，您将需要添加/更改.travis.yml在你的插件中像这样(例如请看这个文件)：

before_install:如果[[" $ {TEST_SUITE} " = = " UITests "]];然后git LFS取回;Git LFS检出;fi

你需要创建一个文件测试/特/ before_install.after.yml在您的插件中添加以下内容(例如请看这个文件)：

- if [["${TEST_SUITE}" == "UITests"]];然后git LFS取回;Git LFS检出;fi
Baidu