danger-plugin-keepachangelog
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

danger-plugin-keepachangelog

npm version

Makes changes to CHANGELOG consistent with keepachangelog standard

Usage

Install:

yarn add danger-plugin-keepachangelog --dev

At a glance:

// dangerfile.js
import { keepachangelog } from 'danger-plugin-keepachangelog'
 
keepachangelog()

Checks

ℹ️ All checks will be skipped if #trivial is present in the title or body of the PR

Situation Message demo
No changes to CHANGELOG.md were found Demo
Missing a section line (eg: ### Fixed) Demo
Missing a new version line (eg: ## [1.0.1] - 2020-03-20) Demo
Having a new version line (when the option changeVersion is set to false) Demo

Options

You can pass options to keepachangelog function:

keepachangelog({ changeVersion: true })
Option Default Description
changeVersion true - true it will fail if a version line is missing
- false it will fail if a new version line is present

Contributing

See CONTRIBUTING.md.

Package Sidebar

Install

npm i danger-plugin-keepachangelog

Weekly Downloads

1,258

Version

1.0.5

License

MIT

Unpacked Size

19.5 kB

Total Files

15

Last publish

Collaborators

  • breno