1.1.4 • Published 4 years ago
danger-plugin-pull-request v1.1.4
danger-plugin-pull-request
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
orfail
) to call if the pull request has no assignees.- Default value:
fail
- Default value:
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
orfail
) to call if the pull request's description is too short.- Default value:
fail
- Default value:
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
orfail
) to call if the pull request's title is invalid.- Default value:
fail
- Default value:
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
orfail
) to call if the pull request's description is too short.- Default value:
fail
- Default value:
checkMergeSquashChecked(reporter)
Checks if merge squash checked. (GitLab only)
Arguments:
reporter
: The reporter (message
,warn
orfail
) to call if the pull request's description is too short.- Default value:
fail
- Default value:
checkDeleteSourceBranchChecked(reporter)
Checks if delete source branch checked. (GitLab only)
Arguments:
reporter
: The reporter (message
,warn
orfail
) to call if the pull request's description is too short.- Default value:
fail
- Default value:
Changelog
See the GitHub release history.
Contributing
See CONTRIBUTING.md.