antoine-dbr/danger-changelog

A plugin that is OCD about your CHANGELOG format.

danger-changelog

A pull request linter plugin to danger.systems that enforces CHANGELOG.md O.C.D. in your projects. This plugin can, for example, make sure the changes are attributes properly and that they are always terminated with a period.

Installation

Add danger-changelog to your Gemfile.

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

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

The plugin supports following configuration options:

• placeholder_line - customize '* Your contribution here.' line.

You can configure plugin using following code:

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

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

Copyright (c) Daniel Doubrovkine, 2016

MIT License, see LICENSE for details.