https://github.com/shelljs/changelog

A simple script to create & update a changelog
https://github.com/shelljs/changelog

Last synced: 4 months ago
JSON representation

A simple script to create & update a changelog

Host: GitHub
URL: https://github.com/shelljs/changelog
Owner: shelljs
License: mit
Created: 2016-06-14T01:39:38.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2022-11-16T06:52:53.000Z (about 3 years ago)
Last Synced: 2025-08-09T15:56:48.671Z (5 months ago)
Language: JavaScript
Size: 26.4 KB
Stars: 5
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

README

# Changelog.js

A simple NodeJS script to create & update a CHANGELOG.md

## Installation and setup

```bash
npm install --save-dev shelljs-changelog
```

Now, add a `script` to `package.json` like so:

```json
"scripts": {
"test": "... whatever you had here before ...",
"changelog": "shelljs-changelog"
},
```

## Dependencies

You'll need to have `curl` installed in order to use this script.

Also, make sure you have internet access when running this.

## Usage example

To update the changelog, run:

```bash
npm run changelog
```

For best results, try to run this after every time you publish.

## Command line options

### `--force`

By default, this script verifies that the changelog diff contains no more than
5 deletions. With `--force` enabled, this step is skipped.