包简介

Workflow related Git hooks.

README 文档

README

This is a "plugin" package which seamlessly integrates with the Git Hooks package.

It will install git hooks, that will automatically run multiple checks on your project to make sure, they follow the projects workflow and naming conventions.

📦 Installation

You install the package via Composer by using the following command:

composer require rugaard/git-hooks-workflow

📝 Configuration

To change the default configuration of one or more script, you need to have a git-hooks.config.json file in your project root. If you don't, you can create it with the following command:

./vendor/bin/git-hooks config

`Rugaard\GitHooks\Workflow\CommitMsg\IssueReferenceCommand`

Checks the commit for an issue reference. Default is GitHub format.

If commit message does not contain an issue reference, the branch name will be checked to see, if an issue reference can be extracted.

Parameter	Description	Default
`branchPattern`	Regex pattern to search branch name for issue reference.	`.*\/#?([0-9]+)-`
`commitPattern`	Regex pattern to search commit message for issue reference.	`#([0-9]+)`
`forcePrefix`	Make sure issue reference is always prefixed with this value.	`#`

`Rugaard\GitHooks\Workflow\PreCommit\BranchNameCommand`

Checks the current branch name and make sure it follows the projects naming convention.

Parameter	Description	Default
`pattern`	Regex pattern to validate branch name	`^(bugfix\|feature\|hotfix\|release)\/(\d+)-([A-Za-z0-9-]+)$`
`renameExample`	Format of branch naming convention	`{type}/{issue-no}-{description}`
`whitelist`	Array of branch names that skips this check.	`['main', 'master', 'develop']`

🚓 License

This package is licensed under MIT.

rugaard/git-hooks-workflow 适用场景与选型建议

rugaard/git-hooks-workflow 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 2 次下载、GitHub Stars 达 0，最近一次更新时间为 2021 年 10 月 21 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「plugin」「git」「composer」「workflow」「hooks」「composer plugin」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 rugaard/git-hooks-workflow 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 rugaard/git-hooks-workflow 我们能提供哪些服务？

定制开发 / 二次开发

基于 rugaard/git-hooks-workflow 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发