2017 © Pedro Peláez
 

library changelog-parser

PHP library used to parse a CHANGELOG.md file and return JSON output

image

kern046/changelog-parser

PHP library used to parse a CHANGELOG.md file and return JSON output

  • Tuesday, March 1, 2016
  • by Kern
  • Repository
  • 2 Watchers
  • 5 Stars
  • 724 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 5 Versions
  • 2 % Grown

The README.md

Changelog Parser

Latest Stable Version Latest Unstable Version Build Status Code Coverage Scrutinizer Code Quality Total Downloads License, (*1)

Introduction

This library is meant to parse changelog files and convert its data to different formats., (*2)

It would be used to get dynamically data from a changelog file to inform users about the different versions and their changes., (*3)

With this library it is easy to use changelog data in any way., (*4)

Installation

You can use composer to set the library as your project dependency, (*5)

composer require kern046/changelog-parser

Usage

To use this library, you can create an instance of the changelog manager, (*6)

use ChangelogParser\Manager\ChangelogManager;

$changelogManager = new ChangelogManager();

To get the last version data of your changelog file, write the following code :, (*7)

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

To get all data contained in the changelog file, use the following method :, (*8)

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

The results of these functions are cached., (*9)

The default cache validity time is one hour., (*10)

You can modify it using the following way :, (*11)

$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);

The Versions

01/03 2016

dev-master

9999999-dev

PHP library used to parse a CHANGELOG.md file and return JSON output

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Axel Venet

version changelog

01/03 2016

dev-develop

dev-develop

PHP library used to parse a CHANGELOG.md file and return JSON output

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Axel Venet

version changelog

01/03 2016

v0.1.2

0.1.2.0

PHP library used to parse a CHANGELOG.md file and return JSON output

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Axel Venet

version changelog

01/03 2016

v0.1.1

0.1.1.0

PHP library used to parse a CHANGELOG.md file and return JSON output

  Sources   Download

MIT

The Requires

  • php >=5.5.0

 

by Axel Venet

version changelog

01/03 2016

v0.1.0

0.1.0.0

PHP library used to parse a CHANGELOG.md file and return JSON output

  Sources   Download

MIT

by Axel Venet

version changelog