Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

skip additional checks if a merge commit #1100

Merged
merged 11 commits into from
Jul 20, 2023
Merged

skip additional checks if a merge commit #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5670232
skip additional checks if a merge commit
delboy1978uk Jul 19, 2023
f8c0cd8
skip on merge commit option
delboy1978uk Jul 20, 2023
4fd2520
skip enforceTypeScopeConventions if a merge commit
delboy1978uk Jul 20, 2023
78c8be0
move setting back in place
delboy1978uk Jul 20, 2023
56c25ce
add commit message and set option in test
delboy1978uk Jul 20, 2023
8464455
fix tests, set skip on merge false
delboy1978uk Jul 20, 2023
d6eff41
remove merge check from scope conventions check
delboy1978uk Jul 20, 2023
e0a57aa
add additional test cases
delboy1978uk Jul 20, 2023
b34b3cd
Update git_commit_message.md
delboy1978uk Jul 20, 2023
eabbaa9
Update CommitMessage.php
delboy1978uk Jul 20, 2023
30e5e2c
add string type to method
delboy1978uk Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/tasks/git_commit_message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ grumphp:
enforce_no_subject_trailing_period: true
enforce_single_lined_subject: true
type_scope_conventions: []
skip_on_merge_commit: true
max_body_width: 72
max_subject_width: 60
matchers:
Expand Down Expand Up @@ -90,6 +91,13 @@ Mark the matchers as case-sensitive.
Mark the matchers as multiline.


**skip_on_merge_commit**

*Default:true*

Skips checking the commit message when the commit is a merge.


**additional_modifiers**

*Default: ''*
Expand Down
23 changes: 17 additions & 6 deletions src/Task/Git/CommitMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@

class CommitMessage implements TaskInterface
{
const MERGE_COMMIT_REGEX =
'(Merge branch|tag \'.+\'(?:\s.+)?|Merge remote-tracking branch \'.+\'|Merge pull request #\d+\s.+)';

/**
* @var TaskConfigInterface
*/
Expand All @@ -43,6 +46,7 @@ public static function getConfigurableOptions(): OptionsResolver
'case_insensitive' => true,
'multiline' => true,
'type_scope_conventions' => [],
'skip_on_merge_commit' => true,
'matchers' => [],
'additional_modifiers' => '',
]);
Expand All @@ -56,6 +60,7 @@ public static function getConfigurableOptions(): OptionsResolver
$resolver->addAllowedTypes('max_body_width', ['int']);
$resolver->addAllowedTypes('max_subject_width', ['int']);
$resolver->addAllowedTypes('case_insensitive', ['bool']);
$resolver->addAllowedTypes('skip_on_merge_commit', ['bool']);
delboy1978uk marked this conversation as resolved.
Show resolved Hide resolved
$resolver->addAllowedTypes('multiline', ['bool']);
$resolver->addAllowedTypes('matchers', ['array']);
$resolver->addAllowedTypes('additional_modifiers', ['string']);
Expand Down Expand Up @@ -94,6 +99,11 @@ public function run(ContextInterface $context): TaskResultInterface
$config = $this->getConfig()->getOptions();
$commitMessage = $context->getCommitMessage();
$exceptions = [];
$isMergeCommit = $this->isMergeCommit($commitMessage);

if ($isMergeCommit && $config['skip_on_merge_commit']) {
return TaskResult::createSkipped($this, $context);
}

if (!(bool) $config['allow_empty_message'] && '' === trim($commitMessage)) {
return TaskResult::createFailed(
Expand Down Expand Up @@ -135,8 +145,7 @@ public function run(ContextInterface $context): TaskResultInterface
);
}


if ($this->enforceTypeScopeConventions()) {
if (!$isMergeCommit && $this->enforceTypeScopeConventions()) {
try {
$this->checkTypeScopeConventions($context);
} catch (RuntimeException $e) {
Expand Down Expand Up @@ -362,9 +371,6 @@ private function checkTypeScopeConventions(GitCommitMsgContext $context): void
? $config['type_scope_conventions']['subject_pattern']
: '([a-zA-Z0-9-_ #@\'\/\\"]+)';

$mergePattern =
'(Merge branch|tag \'.+\'(?:\s.+)?|Merge remote-tracking branch \'.+\'|Merge pull request #\d+\s.+)';

if (count($types) > 0) {
$types = implode('|', $types);
$typesPattern = '(' . $types . ')';
Expand All @@ -375,14 +381,19 @@ private function checkTypeScopeConventions(GitCommitMsgContext $context): void
$scopesPattern = '(:\s|(\((?:' . $scopes . ')\)?:\s))';
}

$rule = '/^' . $specialPrefix . $typesPattern . $scopesPattern . $subjectPattern . '|' . $mergePattern . '/';
$rule = '/^' . $specialPrefix . $typesPattern . $scopesPattern . $subjectPattern . '/';
try {
$this->runMatcher($config, $subjectLine, $rule, 'Invalid Type/Scope Format');
} catch (RuntimeException $e) {
throw $e;
}
}

private function isMergeCommit(string $commitMessage): bool
{
return (bool) \preg_match(self::MERGE_COMMIT_REGEX, $commitMessage);
}

/**
* Gets a clean subject line from the commit message
*
Expand Down
24 changes: 23 additions & 1 deletion test/Unit/Task/Git/CommitMessageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public function provideConfigurableOptions(): iterable
'case_insensitive' => true,
'multiline' => true,
'type_scope_conventions' => [],
'skip_on_merge_commit' => true,
'matchers' => [],
'additional_modifiers' => '',
]
Expand Down Expand Up @@ -670,6 +671,7 @@ function () {
yield 'skip_type_scope_conventions_on_merge' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand All @@ -683,6 +685,7 @@ function () {
yield 'skip_type_scope_conventions_on_merge_branch_gitflow' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand All @@ -696,6 +699,7 @@ function () {
yield 'skip_type_scope_conventions_on_merge_tag_gitflow' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand All @@ -709,6 +713,7 @@ function () {
yield 'skip_type_scope_conventions_on_merge_remote' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand All @@ -722,6 +727,7 @@ function () {
yield 'skip_type_scope_conventions_on_merge_PR' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand All @@ -735,6 +741,7 @@ function () {
yield 'fixup_skip_type_scope_conventions_on_merge' => [
[
'enforce_capitalized_subject' => false,
'skip_on_merge_commit' => false,
'type_scope_conventions' => [
'types' => [
'fix'
Expand Down Expand Up @@ -827,11 +834,26 @@ function () {
function () {
},
];
yield 'dont_skip_on_merge_commit' => [
[
'skip_on_merge_commit' => false,
],
$this->mockCommitMsgContext($this->fixup('Merge branch \'x\' into')),
function () {
},
];
}

public function provideSkipsOnStuff(): iterable
{
return [];
yield 'skip_on_merge_commit' => [
[
'skip_on_merge_commit' => true,
],
$this->mockCommitMsgContext($this->fixup('Merge branch \'x\' into')),
function () {
},
];
}

private function mockCommitMsgContext(string $message): ContextInterface
Expand Down