README.md

changy (change-e)

A simple CLI for maintaining user facing changelogs.

npm install -g changy

Why?

Changesets are awesome but our users don't care about versioning. changy makes it easy to generate date-based changelogs that can show your applications development progress.

.changyrc

The config file for changy. This allows you to configure your time zone as well as they change categories that will be listed in the changelog.

{
    "timezone": "UTC",
    "path": "CHANGELOG.md",
    "changeCategories": [
        "Added",
        "Changed",
        "Fixed"
    ]
}

changeCategories

These are what determines the categories of your changes and the order they will show up in your changelog.

For example take this configuration:

"changeCategories": [
  "Added",
  "Changed",
  "Fixed"
]

Resulting changelog format:

# 2024.11.11

## Added

<!-- Your additions here -->

## Changed

<!-- Your changes here -->

## Fixed

<!-- Your fixes here -->

Note

These will only appear in your changelog if they have changes associated with them.

CLI Reference

To see the most recent information for the CLI run:

npx changy@latest --help