detect-repo-changelog

    1.0.1 • Public • Published

    detect-repo-changelog

    NPM version Downloads Build Status Coverage Status Dependency status Dev Dependency status

    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.

    Install

    npm i detect-repo-changelog

    DownloadsWeekly Downloads

    42,508

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • satazor