shoenig / new-cl

A tool for creating consistent changelog entries consumed by go-changelog

new-cl

Create Changelog entries consumed by Hashicorp's go-changelog

Getting Started

The new-cl command can be installed by running

go install gophers.dev/cmds/new-cl@latest

Optional Configuration

CHANGELOG_DIR environment variable

By default new-cl looks for a .changelog directory for storage of changelog notes. A different directory name can be specified by setting CHANGELOG_DIR to a different name.

e.g., CHANGELOG_DIR=.cl-notes

CHANGELOG_KINDS environment variable

By default new-cl validates note types of bug, improvement, security, breaking-change, deprecation, and note. The acceptable type values can be configured by setting CHANGELOG_KINDS to a comma-separated list of types.

e.g., CHANGELOG_KINDS=bug,feature,notice

Usage

new-cl [type] [pr] <message>

• type: one of bug, improvement, security, breaking-change, deprecation, note
• pr: the PR number assigned by GitHub
• message: (optional) the message of the changelog note

Example Usages

new-cl bug 11235 "Fixed a bug"

Contributing

The gophers.dev/cmds/new-cl module is always improving with new features and error corrections. For contributing bug fixes and new features please file an issue.

License

The gophers.dev/cmds/new-cl module is open source under the BSD