README

一个简单的 PHP 库，通过解析 git log 历史生成变更日志文件。

git-changelog 解析在提供的 工作目录 中 开始日期 和 结束日期 期间内的 git 历史，并生成变更日志。

可以通过设置生成日志时的 输出格式 属性来生成以下输出格式的变更日志。

Markdown (标准 MD 格式)
Remarkup (参见 Phabricator remarkup 指南)
HTML
JSON

提交格式

git-changelog 预期提交采用以下格式-

type : commit-message

类型可以是以下值之一-

fix
feature
general
security

如果提交消息不遵循此格式，或者提供的 type 不是提供的 4 种类型之一，则提交消息将分类到 general 类型。

安装

使用以下命令安装最新版本

$ composer require cshekharsharma/git-changelog

基本用法

<?php

use GitChangeLog\Constants;

require_once '../vendor/autoload.php';

$generator = new \GitChangeLog\ChangeLogGenerator();

$generator->setStartDate('2018-01-01');
$generator->setEndDate('2018-04-01');
$generator->setWorkingDir('/path/to/git/repository');

$generator->setOutputFormat(Constants::OUTPUT_FORMAT_MARKDOWN);

$changelogs = $generator->generate();

第三方包

git-changelog 未使用任何第三方包。

关于

需求

git-changelog 需要 PHP 5.5 或更高版本。

作者

Chandra Shekhar Sharma shekharsharma705@gmail.com

许可证

git-changelog 在 MIT 许可证下授权 - 有关详细信息，请参阅 LICENSE 文件

cshekharsharma / git-changelog

维护者

详细信息

README

提交格式

安装

基本用法

第三方包

关于

需求

作者

许可证