kern046/changelog-parser

PHP库，用于解析CHANGELOG.md文件并返回JSON输出

维护者

详细信息

github.com/Kern046/changelog-parser

源代码

问题

安装次数: 5,787

依赖者: 1

建议者: 0

安全性: 0

星星: 10

关注者: 3

分支: 3

开放问题: 2

v0.1.2 2016-03-01 18:35 UTC

Requires

  • php: >=5.5.0

MIT 02dba57b18c583a2ba6a1db6b5bd1bb1877d442b

  • Axel Venet <kern046.woop@gmail.com>

versionchangelog

This package is auto-updated.

Last update: 2024-09-07 07:12:10 UTC

README

Latest Stable Version Latest Unstable Version Build Status Code Coverage Scrutinizer Code Quality Total Downloads License

介绍

这个库旨在解析变更日志文件并将数据转换为不同的格式。

它可以用来从变更日志文件中动态获取数据，以便通知用户关于不同版本及其更改。

使用此库，可以轻松地以任何方式使用变更日志数据。

安装

您可以使用composer将库设置为项目的依赖项

composer require kern046/changelog-parser

使用方法

要使用此库，您可以创建变更日志管理器的实例

use ChangelogParser\Manager\ChangelogManager;

$changelogManager = new ChangelogManager();

要获取变更日志文件的最新版本数据，请编写以下代码

// The second parameter is optional, default is 'json'
$changelogManager->getLastVersion('CHANGELOG.md', 'json');

要获取变更日志文件中包含的所有数据，请使用以下方法

// The second parameter is optional, default is 'json'
$changelogManager->getAllVersions('CHANGELOG.md', 'json');

这些函数的结果被缓存。

默认缓存有效期为一小时。

您可以使用以下方式修改它

$cacheManager = $changelogManager->getCacheManager();
// The first argument is the validity time in seconds
// In the current example, the cache validity time is one day
$cacheManager->setCacheTime(60 * 60 * 24);