2017 © Pedro Peláez
 

library parseachangelog

Change log parser based on http://keepachangelog.com/

image

mjerwin/parseachangelog

Change log parser based on http://keepachangelog.com/

  • Friday, February 26, 2016
  • by mjerwin
  • Repository
  • 3 Watchers
  • 2 Stars
  • 9 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

mjerwin/parseachangelog

Build Status HHVM Scrutinizer Packagist, (*1)

A library for parsing change logs using the format defined by keepachangelog.com., (*2)

Installation

composer require mjerwin/parseachangelog

Basic Usage

Get changes by version

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

Get all changes

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

Methods

getVersion()

Get the version number of the release e.g. 0.2.0, (*3)

getDate()

Get the date of the release, (*4)

getAdded()

Get an array of messages from the Added section, (*5)

getChanged()

Get an array of messages from the Changed section, (*6)

getDeprecated()

Get an array of messages from the Deprecated section, (*7)

getRemoved()

Get an array of messages from the Removed section, (*8)

getFixed()

Get an array of messages from the Fixed section, (*9)

getSecurity()

Get an array of messages from the Security section, (*10)

toArray()

Represents the release as an array, (*11)

toJson()

Represents the release in JSON format, (*12)

toXml()

Represents the release as XML, (*13)

toHtml()

Represents thr release as HTML using erusev/parsedown, (*14)

The Versions

26/02 2016

dev-develop

dev-develop

Change log parser based on http://keepachangelog.com/

  Sources   Download

MIT

The Requires

 

The Development Requires

by Matthew Erwin

26/02 2016

dev-master

9999999-dev

Change log parser based on http://keepachangelog.com/

  Sources   Download

MIT

The Requires

 

The Development Requires

by Matthew Erwin

26/02 2016

0.9.3

0.9.3.0

Change log parser based on http://keepachangelog.com/

  Sources   Download

MIT

The Requires

 

The Development Requires

by Matthew Erwin

26/02 2016

0.9.2

0.9.2.0

Change log parser based on http://keepachangelog.com/

  Sources   Download

The Requires

 

The Development Requires

by Matthew Erwin

26/02 2016

0.9.1

0.9.1.0

Change log parser based on http://keepachangelog.com/

  Sources   Download

The Requires

 

The Development Requires

by Matthew Erwin

26/02 2016

dev-scrutinizer-patch-1

dev-scrutinizer-patch-1

Change log parser based on http://keepachangelog.com/

  Sources   Download

The Requires

 

The Development Requires

by Matthew Erwin

24/02 2016

0.9.0

0.9.0.0

Change log parser based on http://keepachangelog.com/

  Sources   Download

The Requires

 

The Development Requires

by Matthew Erwin