changelogen for Mac

Generate Beautiful Changelogs using Conventional Commits

Quick Start

Generate a changelog in Markdown format and display in the console:

Generate a changelog, bump the version in package.json and update CHANGELOG.md (without commit):

Bump the version, update CHANGELOG.md, make a git commit and tag, and sync a GitHub release (when the repo is on GitHub):

Without a GitHub token, changelogen opens a browser link so you can create the release manually. With a token (see changelogen gh release), the release is created automatically. CLI Usage

Arguments: --from: Start commit reference. When not provided, latest git tag will be used as default. --to: End commit reference. When not provided, latest commit in HEAD will be used as default. --dir: Path to git repository. When not provided, current working directory will be used as as default. --clean: Determine if the working directory is clean and if it is not clean, exit. --output: Changelog file name to create or update. Defaults to CHANGELOG.md and resolved relative to dir. Use --no-output to write to console only. --noAuthors: Skip contributors section in changelog. --bump: Determine semver change and update version in package.json. --release. Bumps version in package.json, creates a commit and git tags using local git, and creates or updates a GitHub release for the new version when the repository provider is GitHub. You can disable commit using --no-commit, tag using --no-tag, and the GitHub release using --no-github. You can enable the automatic push of the new tag and release commit to your git repository by adding --push. --publish. Publishes package as a new version on npm. You will need to set authorisation tokens separately via .npmrc or environment variables. --publishTag Use custom npm tag for publishing (Default is latest) --nameSuffix: Adds suffix to package name (Example: --nameSuffix canary renames foo to foo-canary) --versionSuffix: Adds suffix to package version. When set without value or to true, uses date + commit hash as commit --canary. Shortcut to --bump --versionSuffix (--nameSuffix will be also added if arg has a string value). -r: Release as specific version. --major: Bump as a semver-major version --minor: Bump as a semver-minor version --patch: Bump as a semver-patch version --premajor: Bump as a semver-premajor version, can set id with string. --preminor: Bump as a semver-preminor version, can set id with string. --prepatch: Bump as a semver-prepatch version, can set id with string. --prerelease: Bump as a semver-prerelease version, can set id with string. --hideAuthorEmail: Do not include author email in changelog if github username cannot be found. [!NOTE] Version numbers starting with 0. or 0.0. follow different rules. In these cases, the second or third digit is treated as the major version. They use the formats 0.major.minor and 0.0.major instead of the standard major.minor.patch. To ensure consistent semantic versioning, start version numbering at 1.0.0.