# changelog-verify

> Verify a changelog has correct entries

Latest version **1.1.2** (published 2018-12-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install changelog-verify
pnpm add changelog-verify
yarn add changelog-verify
bun add changelog-verify
```

Provides the command `changelog-verify`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2018-12-22 |
| First published | 2016-10-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 36.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jess Telford |
| Maintainers | jesstelford |
| Keywords | changelog |

## Links

- npm: https://www.npmjs.com/package/changelog-verify
- npm.io page: https://npm.io/package/changelog-verify

## Dependencies (2)

- [meow](https://npm.io/package/meow.md) ^5.0.0
- [upath](https://npm.io/package/upath.md) ^1.1.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2018-12-22
- 1.1.1 — 2018-12-22
- 1.1.0 — 2017-11-26
- 1.0.4 — 2016-10-24
- 1.0.3 — 2016-10-23
- 1.0.2 — 2016-10-23
- 1.0.1 — 2016-10-22
- 1.0.0 — 2016-10-22

## README

# Changelog Verify [![CircleCI build status](https://circleci.com/gh/jesstelford/changelog-verify.svg?style=svg)](https://circleci.com/gh/jesstelford/changelog-verify)

Ensure that your `CHANGELOG.md` contains a list of changes.

Goes great with
[`version-changelog`](https://github.com/jesstelford/version-changelog).

Add this to your `package.json`:

```json
{
  "scripts": {
    "version": "version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"
  }
}
```

Now whenever you execute `npm version`
(or [`np`](https://github.com/sindresorhus/np)),
your `CHANGELOG.md` will be given the correct version info,
checked for validity
(did you forget to add changelog notes?)
then added to the release commit.

## Options

```
  Verify a changelog has correct entries

  Usage
    $ changelog-verify <filename>

  Options
    --unreleased  Verify that the unreleased section has been modified.
                  (default: false)

  <filename> defaults to CHANGELOG.md
```

The `--unreleased` flag is great for confirming PRs contain a CHANGELOG note.

## Usage

Given the following `./CHANGELOG.md`

```markdown
# Changelog

## [2.0.0] - 2016-10-11

- Reticulated the splines
```

Executing the verficiation script

```bash
changelog-verify ./CHANGELOG.md
```

Will return success (`0`).

See the [tests](test/test.js) for more usage examples.

## Changelog format

This tool assumes a particular format for your changelog,
keeping in style with http://keepachangelog.com:

```markdown
<some intro text>
## [Unreleased]
<optional unreleased notes>
## [<version number>]
<required release notes>
```

Where `<required release notes>` must contain at least one non-empty string
which isn't a heading.

---
_Source: https://npm.io/package/changelog-verify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._