Skip to content
This repository was archived by the owner on Nov 26, 2025. It is now read-only.

dept/changelog

Repository files navigation

Changelog

Changelog
Magically creates a YML file with metadata of a change entry

Install

npm install @deptagency/changelog

or

yarn add @deptagency/changelog

Usage

package.json

{
  "scripts": {
    "changelog": "node ./node_modules/@deptagency/changelog"
  }
}
npm changelog

or

yarn changelog

CLI arguments (optional)

Argument Description Default
path File path ./changelog/unreleased/
file File name %s-%s.yml
File name format
Value Description Slugified
%1$s Jira ticket true
%2$s Changelog message true

Prompt

Question Hint Type
Changelog message ... e.g. Bug ticket title text
Type of change ... use arrow-keys, return to submit autocomplete
Jira ticket ... e.g. HD-987 text
Merge Request ... e.g. 790 text

Icon

Made by Freepik from www.flaticon.com

About

Magically creates a YML file with metadata of a change entry

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors