epicarrow/git-changelog

将应用程序的git日志解析为可读的变更日志的简单服务。

维护者

详细信息

github.com/ferdinandfrank/git-changelog

源代码

问题

安装: 53

依赖关系: 0

建议者: 0

安全: 0

星标: 1

关注者: 3

分支: 0

开放问题: 0

v1.2 2017-01-23 17:32 UTC

Requires

MIT 3a753c8a9f7be1d418c854ad1432f16b414c66d6

  • EpicArrow <ferdinand-frank.woop@web.de>

gitversionlaravelchangelogcommits

This package is not auto-updated.

Last update: 2024-09-28 20:03:47 UTC

README

将应用程序的git日志解析为可读的变更日志的简单服务。

要求

强制要求

  • PHP >= 5.6.4
  • Carbon >= 1.18: 用于格式化git提交的日期

可选要求

  • 一个现有的 >= Laravel 5.3 项目，以便使用全局视图变量 $gitVersion

安装

  1. 要开始使用，请通过Composer包管理器安装Git ChangeLog服务

    composer require epicarrow/git-changelog

  2. 可选：如果您正在使用Laravel并且想要使用全局视图变量 $gitVersion，请在 config/app.php 中的提供者数组中添加以下条目

    'providers' => [
   ...
   ...
   EpicArrow\GitChangeLog\Providers\GitChangeLogServiceProvider::class
]

文档

服务

目前有以下服务可用

EpicArrow\GitChangeLog\GitChangeLog::get([int $count = null])

获取最新的唯一git提交。如果两个连续的提交具有相同的提交信息，则只会检索一个提交。

参数

  • $count (int): 要检索的结果数量。

返回值

检索到的提交作为 EpicArrow\GitChangeLog\Models\Commit 的 array。

EpicArrow\GitChangeLog\GitChangeLog::version()

获取git仓库的最新版本。

返回值

检索到的git仓库的最新版本作为 string 或不存在时为 null。

全局变量

如果您正在使用Laravel并且已将 GitChangeLogServiceProvider 在您的 config/app.php 提供者数组中注册，您可以从每个blade视图中访问以下变量

  • $gitVersion: 与服务 EpicArrow\GitChangeLog\GitChangeLog::version() 对应，并获取git仓库的最新版本。

提交模型 EpicArrow\GitChangeLog\Models\Commit

当通过此服务检索最新的git提交时，您将得到一个 EpicArrow\GitChangeLog\Models\Commit 的 array。此模型具有以下属性

  • $id(string): 提交哈希/id
  • $date(Carbon\Carbon): 提交的日期
  • $message(string): 提交信息
  • $version(string|null): 提交所属的版本（标签）
  • $author(string): 提交的作者
  • $email(string): 提交作者的电邮地址
  • $merge(string|null): 提交的合并信息