danger-changelog
danger-changelog copied to clipboard
dblock
A plugin that is OCD about your CHANGELOG format.
Here's the log: ``` $ bundle exec danger --fail-on-errors=true Passing the note body as a Hash is deprecated. You should just pass the String. [!] The exception involves the following...
https://github.com/hashie/hashie/pull/523
In https://github.com/dblock/strava-ruby-client/pull/23/files#r366316379 we have an issue #22 inside of a sentence. We can warn for that and tell users to make a list with a link.
For example in https://github.com/ashkan18/graphlient/pull/45/commits/dbdb6797caa64289746e958b7ce3b0bbfa5fb0b2 the developer has no idea that the changelog is missing a period.
Many changelogs have all variations of "Fix" vs. "Fixes" vs. "Fixed". Standardize on something.
As discussed in https://github.com/dblock/danger-changelog/pull/41#discussion_r279213302 , Japanese and possibly other languages which use non-latin scripts are not allowed at the beginning of an entry. Emojis are also not accepted (which would...
Could relax semver a bit. ``` ### 0.1 [2018/1/1] ### [0.1] [2018/1/1] ## [0.2] - 2017-06-20 ```
``` ## 0.4.0 (next) ``` vs. ``` ## 0.4.0 (Next) ``` Or some other text.
For example the CHANGELOG entry can contain a typo in username URL or in PR URL: * [#17](https://github.com/dblock/dangerchangelog/pull/17): Fix: handle CHANGELOG lines that mistakenly start with a symbol other than...
Sometimes typos or incorrect spelling appear in the changelog, although it can be prevented by danger. I think as a reference we can take a look on [this](https://github.com/dbgrandi/danger-prose).