npm

Need private packages and team management tools?Check out npm Orgs. »

danger-plugin-complete-pr

1.0.1 • Public • Published

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: 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: 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: 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.

install

npm i danger-plugin-complete-pr

Downloadsweekly downloads

6,214

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability