README
Generi
A Simple CHANGELOG.md Generator for JavaScript / TypeScript Projects.
- ✅ Easy CLI
- ✅ Monorepo support (with Lerna)
Install
npm i -g generi
yarn global add generi
Usage
generi init
Init generi.json
configuration, and, if necessary, a git project
generi log <patch|minor|major>
Generate CHANGELOG.md and the necessary contents
generi log patch
0.1.0 >> 0.1.1
generi log minor
0.1.0 >> 0.2.0
generi log major
0.1.0 >> 1.0.0
generi revert
Revert generi log
last command
Monorepo
Monorepo versions may depend on external tools. Given this, Generi supports lerna workspaces, using the command lerna version
before creating the changelog. In other setups, we recommend disabling the tag
and version
options.
generi.json
Default: silentfalse
Do not emit any message in console
Default: commits"none"
Default format content in CHANGELOG.md
Options: none
| conventional-commits
Default: tagtrue
Release a git tag
Default: versiontrue
Insert new version in package.json
Default: pushfalse
Push commits in actually branch after log
Default: publishfalse
Publish(NPM) package in final log