detect-repo-changelog

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.

Current Tags

• 1.0.1                                ...           latest (9 years ago)

1 Versions

• 1.0.1                                ...           9 years ago