Skip to content

fvnilo/danger-plugin-complete-pr

danger-plugin-complete-pr

Build Status npm version semantic-release

A Danger plugin to verify the completion of a pull request on GitHub.

Usage

Install:

yarn add danger-plugin-complete-pr --dev

At a glance:

dangerfile.js

import * as completePr from 'danger-plugin-complete-pr'

completePr.checkAssignees();
completePr.checkDescription(10);
completePr.checkTitle(/^\[[A-Za-z]+-\d+\]/);

API

checkAssignees([reporter])

Checks is the current pull request has any assignees.

Arguments:

  • [reporter] (Function): The reporter (message, warn or fail) to call if the pull request has no assignees.
    • Default value: fail

checkDescription(minimumLength, [reporter])

Checks if the description of the pull request is long enough.

Arguments:

  • minimumLength (Number): The minimum length for a description to be valid.
  • [reporter] (Function): The reporter (message, warn or fail) to call if the pull request's description is too short.
    • Default value: fail

checkTitle(pattern, [reporter])

Checks if the title of the pull request matches a given pattern.

Arguments:

  • pattern (RegExp): The pattern to test the title with.
  • [reporter] (Function): The reporter (message, warn or fail) to call if the pull request's title is invalid.
    • Default value: fail

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •