Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ieedan/changy
A simple CLI for maintaining user facing changelogs.
https://github.com/ieedan/changy
changelog date generator
Last synced: about 16 hours ago
JSON representation
A simple CLI for maintaining user facing changelogs.
- Host: GitHub
- URL: https://github.com/ieedan/changy
- Owner: ieedan
- License: mit
- Created: 2024-08-06T19:56:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T11:07:33.000Z (about 1 month ago)
- Last Synced: 2024-11-05T13:56:40.474Z (15 days ago)
- Topics: changelog, date, generator
- Language: TypeScript
- Homepage:
- Size: 304 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# changy (change-e)
A simple CLI for maintaining user facing changelogs.
```bash
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.
```js
{
"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:
```json
"changeCategories": [
"Added",
"Changed",
"Fixed"
]
```
Resulting changelog format:
```md
# 2024.11.11
## Added
## Changed
## Fixed
```
> [!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
```