changelog-light

Changelog Light

Generate a changelog with conventional commit types.

Requirements

The basic requirements:

• NodeJS version 14+
• Optionally your system could be running
  • Yarn 1.22+, otherwise NPM should be adequate.

Use

CLI

NPM install...

  $ npm i changelog-light

or Yarn

  $ yarn add changelog-light

Usage

  $ changelog --help
  Generate a CHANGELOG.md with conventional commit types.

  Usage: changelog [options]
  
  Options:
    -c, --commit       Commit CHANGELOG.md and package.json with a release commit
                                                         [boolean] [default: true]
    -d, --date         CHANGELOG.md release date in the form of a valid date
                       string. Uses system new Date([your date])
                                    [string] [default: "2022-10-13T12:25:39.055Z"]
    -n, --non-cc       Allow non-conventional commits to apply a semver weight and
                       appear in CHANGELOG.md under a general type description.
                                                        [boolean] [default: false]
    -o, --override     Use a version you define.                          [string]
    -r, --dry-run      Generate CHANGELOG.md sample output
                                                        [boolean] [default: false]
        --commit-path  CHANGELOG.md path used for commits. This will be "joined"
                       with "remote-url". Defaults to the commits path for GitHub.
                                                     [string] [default: "commit/"]
        --pr-path      CHANGELOG.md path used for PRs/MRs. This will be "joined"
                       with "remote-url". Defaults to the PR path for GitHub.
                                                       [string] [default: "pull/"]
        --remote-url   Git remote get-url for updating CHANGELOG.md base urls.
                       This should start with "http". Defaults to "$ git remote
                       get-url origin"                                    [string]
    -h, --help         Show help                                         [boolean]
    -v, --version      Show version number                               [boolean]

Using within a project

Using changelog-light within a project requires one thing... formatting your commit messages using conventional commit types

This project leverages this conventional commit types resource to determine how CHANGELOG.md is generated.

Example NPM script

Using within a project you could apply changelog-light as a NPM script in package.json

  "scripts": {
    "release": "changelog"
  }

Credit

This project is influenced by the now deprecated project Standard Version.

The primary differences between Standard Version and this project are the weighting assigned to commit message types and a fraction of the features.

Contributing

Contributing? Guidelines can be found here CONTRIBUTING.md.