Have ideas to improve npm?Join in the discussion! »

    @release-it/keep-a-changelog

    2.2.2 • Public • Published

    Keep-a-changelog plugin for release-it

    This release-it plugin maintains your CHANGELOG.md file according to the Keep A Changelog standards.

    The idea and initial implementation comes from @eMarek.

    npm install --save-dev @release-it/keep-a-changelog
    

    In release-it config:

    "plugins"{
      "@release-it/keep-a-changelog": {
        "filename": "CHANGELOG.md"
      }
    }

    Options

    option default value description
    filename CHANGELOG.md File with changelogs.
    strictLatest true Entry of latest version must be present in order to get correct changelog. Set this option to false if you expect latest version without logs.
    addUnreleased false It leaves "Unreleased" title row if set to true.
    keepUnreleased false It leaves "Unreleased" title row unchanged if set to true.
    addVersionUrl false Links the version to the according changeset.

    Install

    npm i @release-it/keep-a-changelog

    DownloadsWeekly Downloads

    603

    Version

    2.2.2

    License

    MIT

    Unpacked Size

    17.9 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar