danger-plugin-pull-request
TypeScript icon, indicating that this package has built-in type declarations

1.1.4 • Public • Published

danger-plugin-pull-request

Build Status npm version semantic-release

A Danger plugin to verify the completion of a pull request. Currently support GitHub and GitLab.

Usage

Install:

yarn add danger-plugin-pull-request --dev

At a glance:

dangerfile.js

import * as pullRequest from 'danger-plugin-pull-request'
 
pullRequest.checkAssignees();
pullRequest.checkDescription(1000);
pullRequest.checkTitle(/^\[[A-Za-z]+-\d+\]/);
pullRequest.checkPRSize(50);
pullRequest.checkMergeSquashChecked(); // GitLab only
pullRequest.checkDeleteSourceBranchChecked(); // GitLab only

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, patternMessage, [reporter])

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

Arguments:

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

checkPRSize(maxSize, [reporter])

Checks if a pull request is too big.

Arguments:

  • maxSize (Number): The maximum changed files count to be valid.
  • reporter: The reporter (message, warn or fail) to call if the pull request's description is too short.
    • Default value: fail

checkMergeSquashChecked([reporter])

Checks if merge squash checked. (GitLab only)

Arguments:

  • reporter: The reporter (message, warn or fail) to call if the pull request's description is too short.
    • Default value: fail

checkDeleteSourceBranchChecked([reporter])

Checks if delete source branch checked. (GitLab only)

Arguments:

  • reporter: The reporter (message, warn or fail) to call if the pull request's description is too short.
    • Default value: fail

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

Package Sidebar

Install

npm i danger-plugin-pull-request

Weekly Downloads

131

Version

1.1.4

License

MIT

Unpacked Size

23 kB

Total Files

15

Last publish

Collaborators

  • rizalibnu