PHPackages                             imshashank/changelog-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. imshashank/changelog-builder

ActiveLibrary

imshashank/changelog-builder
============================

ChangelogBuilder automation in PHP

1.0.0(8y ago)014Apache-2.0PHPPHP >=5.5

Since Sep 3Pushed 8y agoCompare

[ Source](https://github.com/imshashank/ChangelogBuilder)[ Packagist](https://packagist.org/packages/imshashank/changelog-builder)[ Docs](https://github.com/imshashank/ChangelogBuilder)[ RSS](/packages/imshashank-changelog-builder/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (1)Versions (3)Used By (0)

Changelog Builder
=================

[](#changelog-builder)

[![Build Status](https://camo.githubusercontent.com/ef8f3dd4ad14b1ba41cbf6662583738da31b4215b087038e7f9d7d7d3e5a54d7/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f696d7368617368616e6b2f4368616e67656c6f674275696c6465722e7376673f7374796c653d666c6174)](https://travis-ci.org/imshashank/ChangelogBuilder)[![codecov](https://camo.githubusercontent.com/fa5857d15a32b7b9ebd8a68aa302d1f1f388cfafe58194c97325faa3fcf0fc28/68747470733a2f2f636f6465636f762e696f2f67682f696d7368617368616e6b2f4368616e67656c6f674275696c6465722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/imshashank/ChangelogBuilder)[![Latest Stable Version](https://camo.githubusercontent.com/0542b13c4ede4a921b624b70311f36be1bdbba55ffbd203f52fa45c7ad5a5c6e/68747470733a2f2f706f7365722e707567782e6f72672f696d7368617368616e6b2f6368616e67656c6f672d6275696c6465722f76657273696f6e)](https://packagist.org/packages/imshashank/changelog-builder)[![Total Downloads](https://camo.githubusercontent.com/0033e546f152b0207bc6300a20f458addf49a7866f9e4f1c980f95485ec897aa/68747470733a2f2f706f7365722e707567782e6f72672f696d7368617368616e6b2f6368616e67656c6f672d6275696c6465722f646f776e6c6f616473)](https://packagist.org/packages/imshashank/changelog-builder)[![License](https://camo.githubusercontent.com/456d637a2e0f08239dfafa6519bef564a8df1257de11f0a66ccb93a2efbe78ca/68747470733a2f2f706f7365722e707567782e6f72672f696d7368617368616e6b2f6368616e67656c6f672d6275696c6465722f6c6963656e7365)](https://packagist.org/packages/imshashank/changelog-builder)

Ideology
--------

[](#ideology)

We believe each PR must be accompanied by an entry to the CHANGELOG.md. An up-to-date changelog helps in tracking which changes were merged in a given release. It also gives contributers their fair share and allows them to track in which release were their changes merged to the repository.

The Changelog Builder automatically processes all changelog entries. Each pull request is required to have a changelog JSON blob as part of the request. The system also calculates the next version for the package based on the type of the changes that are defined in the given changelog JSON blob.

The update simplifies the process of adding release notes to the CHANGELOG.md file for each pull request. Each merged pull request that was part of the release results in a new entry to the CHANGELOG.md file. The entry describes the change and provides the TAG number and release date.

Dependencies
------------

[](#dependencies)

`chag` is used to update the changelog version in CHANGELOG.md

Install chag using

```
curl -s https://raw.githubusercontent.com/mtdowling/chag/master/install.sh | bash

```

Installing using composer
-------------------------

[](#installing-using-composer)

Add the following to your composer file and then run `composer install`

```
{
        "imshashank/changelog-builder": "*"
}

```

Using Changelog
---------------

[](#using-changelog)

Create a new blurb in folder `.changes/nextrelease/`. The name of the json blrb should be unique in that folder. To create a new Changelog, just run the below command.

```