Socket
Socket
Sign inDemoInstall

changelogen

Package Overview
Dependencies
Maintainers
1
Versions
30
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

changelogen

Generate Beautiful Changelogs using Conventional Commits


Version published
Weekly downloads
56K
increased by60.5%
Maintainers
1
Weekly downloads
 
Created
Source

changelogen

npm version npm downloads Github Actions Codecov

Generate Beautiful Changelogs using Conventional Commits

Quick Start

Generate changelog in markdown format to the console output:

npx changelogen@latest

CLI Usage

npx changelogen@latest [--from=...] [--to=...] [<rootDir>]

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.
  • rootDir: Path to git repository. When not provided, current working directory will be used as as default.

Configuration

Configuration is loaded by unjs/c12 from cwd. You can use either changelog.json, changelog.{ts,js,mjs,cjs}, .changelogrc or use the changelog field in package.json.

See ./src/config.ts for available options and defaults.

💻 Development

  • Clone this repository
  • Enable Corepack using corepack enable (use npm i -g corepack for Node.js < 16.10)
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Made with 💛

Published under MIT License.

FAQs

Package last updated on 12 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc