cz-pnpm-workspace-changelog

A fork of cz-lerna-changelog adapted for pnpm workspaces.

About

This package is part of the commitizen family. It prompts for conventional changelog standard in a pnpm workspace environment.

Installation

# Install commitizen and this package
npm install --save-dev commitizen cz-pnpm-workspace-changelog @commitlint/cli

Configuration

Commitizen Configuration

Add this to your package.json:

{
  "config": {
    "commitizen": {
      "path": "cz-pnpm-workspace-changelog"
    }
  }
}

or create a .czrc file at root:

{
  "path": "cz-pnpm-workspace-changelog"
}

Commitlint Configuration

Create a commitlint.config.js in your project root:

module.exports = {
  extends: ['./node_modules/cz-pnpm-workspace-changelog/commitlint']
};

This will use the predefined rules that include:

• feat
• fix
• docs
• style
• refactor
• test
• revert
• wip

Usage

When you commit with commitizen, you'll be prompted to fill out any required commit fields at commit time. The package will automatically detect which packages in your pnpm workspace have been affected by your changes.

Example view:

Status

License

MIT