cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: do not allow squash! commits when merging (#32023)

Browse Source 
While `fixup! ` is fine, `squash! ` means that the commit message needs
tweaking, which cannot be done automatically during merging (i.e. it
should be done by the PR author).

Previously, `validate-commit-message` would always allow
`squash! `-prefixed commits, which would cause problems during merging.

This commit changes `validate-commit-message` to make it configurable
whether such commits are allowed and configures the
`gulp validate-commit-message` task, which is run as part of the `lint`
job on CI, to not allow them.

NOTE: This new check is disabled in the pre-commit git hook that is used
      to validate commit messages, because these commits might still be
      useful during development.

PR Close #32023
This commit is contained in:
George Kalpakas
2019-08-06 20:24:10 +03:00
committed by Kara Erickson
parent 2b289250d8
commit c0d5684078
3 changed files with 49 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
tools/validate-commit-message/validate-commit-message.js
View File

@ -17,15 +17,21 @@
'use strict';
const config = require('./commit-message.json');
const FIXUP_SQUASH_PREFIX_RE = /^(?:fixup|squash)! /i;
const FIXUP_PREFIX_RE = /^fixup! /i;
const SQUASH_PREFIX_RE = /^squash! /i;
const REVERT_PREFIX_RE = /^revert:? /i;
module.exports = commitHeader => {
module.exports = (commitHeader, disallowSquash) => {
if (REVERT_PREFIX_RE.test(commitHeader)) {
return true;
}
const {header, type, scope} = parseCommitHeader(commitHeader);
const {header, type, scope, isSquash} = parseCommitHeader(commitHeader);
if (isSquash && disallowSquash) {
error('The commit must be manually squashed into the target commit', commitHeader);
return false;
}
if (header.length > config.maxLength) {
error(`The commit message header is longer than ${config.maxLength} characters`, commitHeader);
@ -63,8 +69,9 @@ function error(errorMessage, commitHeader) {
}
function parseCommitHeader(header) {
const isFixupOrSquash = FIXUP_SQUASH_PREFIX_RE.test(header);
header = header.replace(FIXUP_SQUASH_PREFIX_RE, '');
const isFixup = FIXUP_PREFIX_RE.test(header);
const isSquash = SQUASH_PREFIX_RE.test(header);
header = header.replace(FIXUP_PREFIX_RE, '').replace(SQUASH_PREFIX_RE, '');
const match = /^(\w+)(?:\(([^)]+)\))?\: (.+)$/.exec(header) || [];
@ -72,6 +79,6 @@ function parseCommitHeader(header) {
header,
type: match[1],
scope: match[2],
subject: match[3], isFixupOrSquash,
subject: match[3], isFixup, isSquash,
};
}