https://github.com/nicinabox/changelog

A tool for parsing sections from formatted changelogs
https://github.com/nicinabox/changelog

Last synced: about 1 month ago
JSON representation

A tool for parsing sections from formatted changelogs

• Host: GitHub
• URL: https://github.com/nicinabox/changelog
• Owner: nicinabox
• Created: 2015-11-16T20:45:31.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-19T01:16:16.000Z (about 9 years ago)
• Last Synced: 2024-10-06T18:15:02.189Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# changelog

A tool for parsing sections from formatted changelogs

**/!\ Not currently published on npm due to naming conflicts.**

## Changelog anatomy

* Sections must begin with with heading identifier (default: `#`)

* Section content is recommended to be a list

See this project's changelog for an example.

## Usage

```javascript

var changelog = require('changelog')([options])

changelog.latest(function(notes) {

  // notes is an array of section objects

  // => [{

  //      version: '1.0.0',

  //      body: '* Initial release',

  //      notes: [

  //        'Initial release'

  //      ]

  //    }]

})

```

# Options

**filename** `CHANGELOG.md`

The name of your release notes for changelog file.

**headingIdentifier** `#`

The character(s) that identify a heading.

## License

ISC (c) 2015 Nic Aitch