README

一个用于解析按照 keepachangelog.com 定义的格式的变更日志的库。

安装

composer require mjerwin/parseachangelog

基本用法

按版本获取变更

$changelog = new Reader('path_to_changelog.md');
$release = $changelog->getRelease('0.2.0');
print_r($release->getAdded());

获取所有变更

$changelog = new Reader('path_to_changelog.md');
$releases = $changelog->getReleases();
foreach($releases as $release)
{
	echo $release->getVersion();
	foreach ($release->getChanged() as $change)
	{
		echo $change;
	}
}

方法

getVersion()

获取发布版本的版本号，例如 0.2.0

getDate()

获取发布日期

getAdded()

获取 Added 部分的消息数组

getChanged()

获取 Changed 部分的消息数组

getDeprecated()

获取 Deprecated 部分的消息数组

getRemoved()

获取 Removed 部分的消息数组

getFixed()

获取 Fixed 部分的消息数组

getSecurity()

获取 Security 部分的消息数组

toArray()

将发布表示为数组

toJson()

将发布表示为 JSON 格式

toXml()

将发布表示为 XML

toHtml()

使用 erusev/parsedown 将发布表示为 HTML

mjerwin /

维护者

详情