danger-changelog

A plugin for danger.systems that obsessive-compulsively lints your project’s CHANGELOG.md. It can make sure, for example, that changes are attributed properly, and that they’re always terminated with a period.

Installation

Add danger-changelog to your Gemfile.

gem 'danger-changelog', '~> 0.3.0'

Add changelog.check to your Dangerfile. Make a pull request and see this plugin in action.

Usage

Methods and attributes from this plugin are available in your Dangerfile under the changelog namespace.

Configuration

You can configure the plugin in Dangerfile.

Danger::Changelog.configure do |config|
  config.placeholder_line = "Nothing yet."
end

The following options are supported.

placeholder_line

Customize the * Your contribution here. line. Set the value to nil to stop checking for one.

changelog.filename

Set the CHANGELOG file name, defaults to CHANGELOG.md.

changelog.check

Run all checks with defaults.

changelog.have_you_updated_changelog?

Checks whether you have updated CHANGELOG.md.

changelog.is_changelog_format_correct?

Checks whether the CHANGELOG format is correct.

Contributing

See CONTRIBUTING.

Copyright

MIT License, see LICENSE for details.