detect-repo-changelog

Scans a repository directory, searching for a changelog file

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
detect-repo-changelog
1.0.16 years ago6 years agoMinified + gzip package size for detect-repo-changelog in KB

Readme

detect-repo-changelog
!NPM versionnpm-imagenpm-url !Downloadsdownloads-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependency statusdavid-dm-imagedavid-dm-url !Dev Dependency statusdavid-dm-dev-imagedavid-dm-dev-url
Scans a repository directory, searching for a changelog file.
Uses changelog-filename-regex to match against a variety of changelog filenames.

Installation

$ npm install detect-repo-changelog

Usage

detectRepoChangelog(dir) -> Promise
const detectRepoChangelog = require('detect-repo-changelog');

detectRepoChangelog('./some-repository-directory')
.then((changelogFile) => {
    if (changelogFile) {
        console.log(`changelog file is ${changelogFile}`);
    } else {
        console.log('no changelog detected');
    }
});

Tests

$ npm test
$ npm test-cov to get coverage report

License

Released under the MIT License.