README

在开始之前，请仔细阅读本指南。

此仓库的作用是什么？

简要介绍
版本
依赖关系
如何使用
贡献

简要介绍

Git hooks是Git在仓库中发生特定操作时执行的脚本。它们允许您根据您的开发工作流程自动化自定义任务。

这是Git的内置功能，即无需下载即可使用。

一些有趣的用途示例包括

- Deploy da aplicação após um git push no repositório;
- Checagem de sintaxe ou padrões de código antes de um git commit;
- gerar documentação antes do envio das modificações;

要激活一个hook，只需创建一个文件并将其保存到.git/hooks/文件夹中。当您在仓库中执行特定命令（提交、推送等）时，Git会在hooks目录中检查是否有关联的脚本要执行。文件名由Git预先定义。

默认语言是Shell脚本。但您可以用任何脚本语言编写hooks，只要该语言的解释器在系统环境变量中可用。

版本

dev-main

这是一个还在开发初期的项目，没有命名稳定版本，因此我们将使用dev-main来指代当前开发中的版本。

依赖关系

Sistema Operacional Unix
php: =>5.4
rskuipers/php-assumptions: ^0.8.0
squizlabs/php_codesniffer: 3.*

如何使用

配置

将以下脚本集添加到composer.json中以进行默认安装。

"scripts": {
    "install-hooks": ["sh ./vendor/rubeus/git-hooks/src/setup.sh"],
    "post-install-cmd": ["@install-hooks"],
    "post-update-cmd": ["@install-hooks"]
}

您可以根据您的项目自定义要使用的工具，选项包括

项目	环境	用途
自动化	开发	`"sh ./vendor/rubeus/git-hooks/src/setup.sh automacao development"`
自动化	测试	`"sh ./vendor/rubeus/git-hooks/src/setup.sh automacao test"`
app-retencao-totvs	开发	`"sh ./vendor/rubeus/git-hooks/src/setup.sh app-retencao-totvs development"`
app-retencao-totvs	测试	`"sh ./vendor/rubeus/git-hooks/src/setup.sh app-retencao-totvs test"`
ps-gerenciado	开发	`"sh ./vendor/rubeus/git-hooks/src/setup.sh ps-gerenciado development"`
ps-gerenciado	测试	`"sh ./vendor/rubeus/git-hooks/src/setup.sh ps-gerenciado test"`

安装

使用以下命令安装此项目的git-hooks脚本

composer require --dev "rubeus/git-hooks:dev-master"

注意：在执行此安装到您的项目时，不要忘记使用--dev参数，此项目的脚本不应用于生产服务器。

更新

步骤1

Confira se há novas configurações disponíveis e em caso positivo visite seu arquivo **composer.json** para alterá-las.

步骤2

Execute o `composer update` normalmente para atualização dos scripts git-hooks, quando disponíveis.

贡献

目前，您可以通过以下方式为此项目做出贡献

建议
编写测试
代码审查
其他指南

rubeus / git-hooks

维护者

详细信息