Wondering what’s next for npm?Check out our public roadmap! »

    changelog-writer

    1.4.0 • Public • Published

    changelog-writer

    A tool to help you generate or write your project changelog file

    How to use changelog-writer

    Installation

    Inside your project run this command to install changelog-witer:

    sudo npm install changelog-writer --save

    Start

    For the first input run this command:

    npm run change

    • You will be asked to "Enter initial version (ex 1.0.0):"
    • Input your initial version, then press ENTER.
    • Next, you be asked this:

    Specify change (added, changed, deprecated, removed, fixed, security):

    • Here, use the format below to input the type of change you want to log:

    SPECIFY CHANGE TYPE=[STATEMENT1, STATEMENT2, etc...]

    Example:

    added=[created login function, created registration form, created a validation function]

    • Once you press ENTER, the message below will appear:

    write successful

    • Next, you will be asked as follows:

    Specify change (added, changed, deprecated, removed, fixed, security):

    • Repeat

    Input change

    For inputs after the first session:

    npm run change type SPECIFY-INPUT-TYPE

    • INPUT TYPES: patch, minor, major
    • For PATCH: Inputs will can be FIXED,CHANGED or REMOVED and the command should be "fixed=[bug1,bug2, etc..]"
    • For MAJOR and MINOR: Inputs will can be ADDED, CHANGED, DEPRECATED, SECURITY and the command should be "added=[feature1, feature2, etc..]".

    Generate CHANGELOG.md

    For creation or update of the CHANGELOG.md

    npm run change log

    Install

    npm i changelog-writer

    DownloadsWeekly Downloads

    0

    Version

    1.4.0

    License

    ISC

    Unpacked Size

    12.7 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar