c0d5684078
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
62 lines
2.0 KiB
JavaScript
62 lines
2.0 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright Google Inc. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
|
|
// tslint:disable:no-console
|
|
module.exports = (gulp) => () => {
|
|
try {
|
|
const validateCommitMessage = require('../validate-commit-message');
|
|
const shelljs = require('shelljs');
|
|
|
|
shelljs.set('-e'); // Break on error.
|
|
|
|
let baseBranch = 'master';
|
|
const currentVersion = require('semver').parse(require('../../package.json').version);
|
|
const baseHead =
|
|
shelljs
|
|
.exec(`git ls-remote --heads origin ${currentVersion.major}.${currentVersion.minor}.*`)
|
|
.trim()
|
|
.split('\n')
|
|
.pop();
|
|
if (baseHead) {
|
|
const match = /refs\/heads\/(.+)/.exec(baseHead);
|
|
baseBranch = match && match[1] || baseBranch;
|
|
}
|
|
|
|
// We need to fetch origin explicitly because it might be stale.
|
|
// I couldn't find a reliable way to do this without fetch.
|
|
const result = shelljs.exec(
|
|
`git fetch origin ${baseBranch} && git log --reverse --format=%s origin/${baseBranch}..HEAD`);
|
|
|
|
if (result.code) {
|
|
throw new Error(`Failed to fetch commits: ${result.stderr}`);
|
|
}
|
|
|
|
const commitsByLine = result.trim().split(/\n/).filter(line => line != '');
|
|
|
|
console.log(`Examining ${commitsByLine.length} commit(s) between ${baseBranch} and HEAD`);
|
|
|
|
if (commitsByLine.length == 0) {
|
|
console.log(`There are zero new commits between ${baseBranch} and HEAD`);
|
|
}
|
|
|
|
const disallowSquashCommits = true;
|
|
const someCommitsInvalid =
|
|
!commitsByLine.every(m => validateCommitMessage(m, disallowSquashCommits));
|
|
|
|
if (someCommitsInvalid) {
|
|
throw new Error(
|
|
'Please fix the failing commit messages before continuing...\n' +
|
|
'Commit message guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines');
|
|
}
|
|
} catch (err) {
|
|
console.error(err);
|
|
process.exit(1);
|
|
}
|
|
};
|