README

基于Git的变更日志

此包从git提交生成类似变更日志的报告。每个标签都会列出其日期和包含在其中的任何带有特定字符串（默认为!public或@public）的提交

要求

PHP必须能够运行exec().
必须安装Git！你可能还需要一些标签...

代码示例

$changeLog = new MaxBrokman\GitChangeLog\ChangeLog( new MaxBrokman\GitChangeLog\Git );
$log = $changeLog->getChangeLog( $page = 1 );

将返回类似

[
    {
        "tag": "v1",
        "date": 1409965746, // utc time
        "changesSinceLastTag":
            [
                {
                    "commit": "9e9125b", // Short commit hash
                    "author": "Max Brokman <max.brokman@gmail.com>",
                    "message": "Commit Message @public"
                },
            ...
            ]
    },
    ...
]

安装

使用composer，需要

 "maxbrokman/git-change-log": "0.1.*"

使用场景

我在一家大公司的一个内部项目上工作。我们的一些利益相关者想要了解应用程序发生的情况。我们每天发布几次，这个包允许我们在应用程序内部提供一个更新列表，而不需要手动维护变更日志。我们使用 !public 在提交消息中标记它们为公共（在我们的情况下是内部）消费。

API参考

要更改用于查找公共提交消息的模式，您可以在传递给ChangeLog的MaxBrokman\GitChangeLog\Git实例上调用setPublicMarker( "grep pattern" )

要更改每页的结果数，您可以在MaxBrokman\GitChangeLog\ChangeLog上调用setPerPage( 100 )

测试

测试使用 PHPUnit 运行。从根目录运行phpunit

GitTest.php需要一个带有标签v0.0.1的git仓库

许可

MIT许可（MIT）

特此授予任何人免费获得本软件及其相关文档副本（“软件”）的副本的权利，无论是否出于商业目的，均可不受限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向软件提供者提供软件的人这样做，前提是遵守以下条件

maxbrokman / git-change-log

维护者

详细信息

README

基于Git的变更日志

要求

代码示例

安装

使用场景

API参考

测试

许可