@discordx/changelog
v2.12.0
Published
changelog generator, written in TypeScript with Node.js
Downloads
103
Maintainers
Readme
📖 Introduction
changelog generator, written in TypeScript with Node.js
💻 Installation
Version 16.6.0 or newer of Node.js is required
npm install @discordx/changelog
yarn add @discordx/changelog
Supported Scopes
build, chore, ci, docs, feat, fix, refactor, revert, test, types, workflow, BREAKING CHANGE
Options
The following options are only available
| Name | Required | Default | Description |
| -------------- | -------- | ---------------- | ----------------------------- |
| --root | No | "./" | root folder path |
| --out | No | "./CHANGELOG.md" | changelog file path |
| --tag | No | "v*" | tag to match with releases |
| --tag-replace | No | undefined | replacement in tag |
| --ignore-scope | No | undefined | ignore scopes |
| --header | No | # Stage\n\n
| set custom header |
| --only-stage | No | false | generate only stage changelog |
📜 Documentation
☎️ Need help?
- Check frequently asked questions
- Check examples
- Ask in the community Discord server