bitexpert/captainhook-validateauthor

Captain Hook 插件,用于检查提交作者是否有效(例如,电子邮件是否在白名单中)

v0.8.0 2023-01-01 19:02 UTC

README

此包为Captain Hook提供操作,当作者名称或电子邮件不匹配在captainhook.json配置文件中定义的正则表达式时,将拒绝提交。如果想要确保您的私人电子邮件地址不会出现在公司的git仓库中,请使用此操作。

Build Status Coverage Status Mastodon Follow

安装

安装bitexpert/captainhook-validateauthor的首选方式是通过Composer。可以将bitexpert/captainhook-validateauthor作为开发依赖项添加,如下所示

composer.phar require --dev bitexpert/captainhook-validateauthor

使用方法

将以下代码添加到您的captainhook.json配置文件中

{
  "pre-commit": {
    "enabled": true,
    "actions": [
      {
        "action": "\\bitExpert\\CaptainHook\\ValidateAuthor\\ValidateAuthorAction",
        "options": {
            "name": "/^[A-Za-z0-09]+$/",
            "email": "/@example.com$/"
        }
      }
    ]
  }
}

Captain Hook现在将在每次提交时检查作者名称和电子邮件是否与定义的正则表达式匹配。如果不匹配,则将取消提交。

贡献

请随时fork现有功能或添加新功能,并通过拉取请求发送您的更改!为了建立一致的代码质量,请为所有更改提供单元测试,并调整文档。

想要贡献吗?

如果您觉得有东西可以分享,我们非常愿意欢迎您。查看贡献指南,了解如何以及我们希望您做什么。

许可

Captain Hook Validate Author Action在Apache 2.0许可下发布。