fix(dev-infra): extract commit headers before checking commit message validity (#36733)

This commit fixes an issue where adding `fixup` commits was triggering a lint error. The problem was caused by the fact that we used the entire message body while checking whether `fixup` commit has a corresponding "parent" commit in a range. This issue was found after enforcing a check that exits the process if there is an invalid commit message found (4341743b4a).

PR Close #36733
This commit is contained in:
Andrew Kushnir 2020-04-20 16:50:25 -07:00 committed by Matias Niemelä
parent 458dc10ddc
commit 51b09244ff
1 changed files with 6 additions and 1 deletions

View File

@ -11,6 +11,9 @@ import {parseCommitMessage, validateCommitMessage, ValidateCommitMessageOptions}
// Whether the provided commit is a fixup commit. // Whether the provided commit is a fixup commit.
const isNonFixup = (m: string) => !parseCommitMessage(m).isFixup; const isNonFixup = (m: string) => !parseCommitMessage(m).isFixup;
// Extracts commit header (first line of commit message).
const extractCommitHeader = (m: string) => parseCommitMessage(m).header;
/** Validate all commits in a provided git commit range. */ /** Validate all commits in a provided git commit range. */
export function validateCommitRange(range: string) { export function validateCommitRange(range: string) {
// A random value is used as a string to allow for a definite split point in the git log result. // A random value is used as a string to allow for a definite split point in the git log result.
@ -35,7 +38,9 @@ export function validateCommitRange(range: string) {
const allCommitsInRangeValid = commits.every((m, i) => { const allCommitsInRangeValid = commits.every((m, i) => {
const options: ValidateCommitMessageOptions = { const options: ValidateCommitMessageOptions = {
disallowSquash: true, disallowSquash: true,
nonFixupCommitHeaders: isNonFixup(m) ? undefined : commits.slice(0, i).filter(isNonFixup) nonFixupCommitHeaders: isNonFixup(m) ?
undefined :
commits.slice(0, i).filter(isNonFixup).map(extractCommitHeader)
}; };
return validateCommitMessage(m, options); return validateCommitMessage(m, options);
}); });