tjvb/githash

从您的项目中获取当前的 git 哈希值。

维护者

详细信息

gitlab.com/tjvb/githash

源代码

问题

资助包维护!
Paypal
tvbeek/
TJVB

安装次数: 10 377

依赖: 1

建议者: 0

安全: 0

星星: 1

分支: 1

1.3.0 2023-11-24 09:40 UTC

This package is auto-updated.

Last update: 2024-09-15 09:56:27 UTC


README

Latest Stable Version Pipeline status Coverage report Tested on PHP 8.0 to 8.2 Latest Unstable Version

PHP Version Require PHPMD PHPStan PHPCS

License

此包旨在提供一个有用的选项,用于从当前提交中获取哈希值。

使用方法

try {
    $retriever = Retriever::getWithFactory(GitHashFinderFactory::withDefaultFinders());
    echo $retriever->getHash($path)->hash() . PHP_EOL;
} catch (GitHashException $exception) {
    echo 'Failed to get the hash ' .  $exception->getMessage() . PHP_EOL;
}

示例

有关如何使用此包的示例,请参阅 docs/examples。

安装

您可以通过执行以下命令使用 composer 安装此包:composer require tjvb/githash

不同的 HashFinders

该包提供了 3 种不同的 GitHashFinder,它们各有优缺点。

GitHashFinder要求优点缺点
GitProcessCommandHashFinder需要 symfony/process 包和 git 可执行文件。此包使用 symfony/process 包执行 git 命令以获取良好的反馈。您需要安装此包并确保 git 命令可用。
GitShellExecCommandHashFinder需要 shell_exec PHP 函数和 git 可执行文件。此包执行 git 命令。您需要确保 shell_exec 和 git 命令可用。
GitFileSystemHashFinder一个分支。它读取 git 文件,不需要 git 可执行文件。存储库需要有一个分支,它不适用于分离头。

Laravel 包

如果您使用 Laravel,可以使用 tjvb/laravel-githash,此包可以将哈希值添加到您的日志文件中,并提供一个 blade 组件来显示哈希值。

变更日志

我们在 CHANGELOG 中(尝试)记录了所有变更,请阅读以获取更多信息。

贡献

欢迎您贡献力量,请参阅 CONTRIBUTING

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件