bitboss-hub / git-version-output
暂时没有
v0.2.5
2024-05-21 15:00 UTC
Suggests
- symfony/process: Used rather than `shell_exec` if available (>=3.3).
README
一个辅助类,用于获取项目的当前git版本。
预期存在一个包含版本字符串的 version 文件在你的项目 base_path() 中,或者git二进制文件可用。
安装
在你的 Laravel/Lumen 项目中要求它
composer require bitboss-hub/laravel-git-version-output
可选包
如果可用,此模块使用 Symfony的Process组件,否则回退到 shell_exec。因此,如果你的部署环境禁用了 shell_exec,你可以通过安装 symfony/process 来解决这个问题。
使用
你可以使用以下方式获取git版本数组
\BitBossHub\LaravelGitVersionOutput\GitVersionOutputHelper::getInformations()
它将输出一个数组
"app_name" => "Laravel"
"tag" => "v1.0"
"commit" => "g796af4b6"
"since_tag" => "5009"
"build_date" => "2023-12-21 10:26:47"
应用名称是从 Config::get('app.name', 'app') 取得的,因此你可以在你的 config/app.php 文件中配置它或保留默认的 app。
推荐使用模式
确保你的git标签已推送到你的服务器,以便正确描述版本。
在开发和可能是在测试环境中,允许版本自动确定(这是通过 git describe 实现的)。
如何工作
当这个包第一次被调用时,它会在你的项目目录中创建一个 version 文件。
当这个 version 文件存在时,该包将使用其内容。
请确保将其添加到 .gitignore 文件中,以便保持你的工作树干净,并且不会意外提交它。
作为你的生产部署过程的一部分,请记住每次执行新的部署时都要删除此文件。