Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vtex/danger-plugin-keepachangelog
Makes changes to CHANGELOG consistent with keepachangelog standard
https://github.com/vtex/danger-plugin-keepachangelog
Last synced: about 1 month ago
JSON representation
Makes changes to CHANGELOG consistent with keepachangelog standard
- Host: GitHub
- URL: https://github.com/vtex/danger-plugin-keepachangelog
- Owner: vtex
- License: mit
- Created: 2020-03-22T00:50:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:32:25.000Z (over 1 year ago)
- Last Synced: 2024-11-07T14:04:34.601Z (about 2 months ago)
- Language: TypeScript
- Size: 193 KB
- Stars: 8
- Watchers: 108
- Forks: 4
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# danger-plugin-keepachangelog
[](https://badge.fury.io/js/danger-plugin-keepachangelog)
> Makes changes to CHANGELOG consistent with [keepachangelog](https://keepachangelog.com/en/1.0.0/) standard
## Usage
Install:
```sh
yarn add danger-plugin-keepachangelog --dev
```
At a glance:
```js
// 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](https://github.com/klzns/test-repo/pull/11)
Missing a section line (eg: `### Fixed`) | [Demo](https://github.com/klzns/test-repo/pull/12)
Missing a new version line (eg: `## [1.0.1] - 2020-03-20`) | [Demo](https://github.com/klzns/test-repo/pull/14)
Having a new version line (when the option `changeVersion` is set to `false`) | [Demo](https://github.com/klzns/test-repo/pull/13)
### Options
You can pass options to `keepachangelog` function:
```js
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](CONTRIBUTING.md).