fix: add support for branch-only commit message types.

Author: hansl

scripts/test-commit-messages.js

@@ -1,9 +1,15 @@
+'use strict';
+
 require('../lib/bootstrap-local');
 
+const fs = require('fs');
+const path = require('path');
 const validateCommitMessage = require('./validate-commit-message');
-const exec = require('child_process').exec;
+const execSync = require('child_process').execSync;
 const chalk = require('chalk');
 const Logger = require('@ngtools/logger').Logger;
+const configPath = path.resolve(__dirname, './validate-commit-message/commit-message.json');
+const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
 require('rxjs/add/operator/filter');
 
 // Configure logger
@@ -23,39 +29,64 @@ logger.subscribe((entry) => {
 });
 
 logger
-  .filter((entry) => entry.level == 'fatal')
+  .filter((entry) => entry.level === 'fatal')
   .subscribe(() => {
     process.stderr.write('A fatal error happened. See details above.');
     process.exit(1);
   });
 
 // Note: This is based on the gulp task found in the angular/angular repository
+execSync('git fetch origin');
 
-exec(
-  'git fetch origin master:master && git log --reverse --format=%s master.. --no-merges',
-  (error, stdout, stderr) => {
-    if (error) {
-      logger.fatal(stderr);
-      return;
-    }
-
-    const output = stdout.trim();
-    if (output.length == 0) {
-      logger.warn('There are zero new commits between this HEAD and master');
-      return;
-    }
-
-    const commitsByLine = output.split(/\n/);
-
-    logger.info(`Examining ${commitsByLine.length} commit(s) between HEAD and master`);
-
-    const someCommitsInvalid = !commitsByLine.every(validateCommitMessage);
-
-    if (someCommitsInvalid) {
-      logger.error('Please fix the failing commit messages before continuing...');
-      logger.fatal(
-        'Commit message guidelines: https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md#commit');
-    } else {
-      logger.info('All commit messages are valid.');
-    }
-  });
+// Find the branch
+const branchRefs = {};
+for (const name of config['branches']) {
+  const output = execSync(`git show-ref --hash ${name}`, { encoding: 'utf-8' });
+  if (output) {
+    branchRefs[name] = output;
+  }
+}
+logger.info(`Found refs for branches:\n  ${Object.entries(branchRefs).forEach(([key, value]) => {
+  return `${key} => ${value}`;
+}).join('\n  ')}`);
+
+
+const output = execSync('git log --format="%H %s" --no-merges', { encoding: 'utf-8' });
+
+if (output.length === 0) {
+  logger.warn('There are zero new commits between this HEAD and master');
+  return;
+}
+
+const commitByLines = [];
+let branch = null;
+
+// Finding the closest branch marker.
+for (const line of output.split(/n/)) {
+  const [hash, ...messageArray] = line.split(/ /);
+  const message = messageArray.join(' ');
+
+  const maybeBranch = Object.keys(branchRefs).find(branchName => branchRefs[branchName] == hash);
+  if (maybeBranch) {
+    branch = maybeBranch;
+    break;
+  }
+  commitByLines.push(message);
+}
+
+if (!branch) {
+  logger.fatal('Something wrong happened.');
+  return;
+}
+
+logger.info(`Examining ${commitsByLine.length} commit(s) between HEAD and ${branch}`);
+
+const someCommitsInvalid = !commitsByLine.every(validateCommitMessage);
+
+if (someCommitsInvalid) {
+  logger.error('Please fix the failing commit messages before continuing...');
+  logger.fatal(
+    'Commit message guidelines: https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md#commit');
+} else {
+  logger.info('All commit messages are valid.');
+}

scripts/validate-commit-message/commit-message.json

@@ -1,15 +1,19 @@
 {
   "maxLength": 100,
-  "types": [
-    "build",
-    "ci",
-    "docs",
-    "feat",
-    "fix",
-    "perf",
-    "refactor",
-    "style",
-    "test",
-    "tool"
+  "types": {
+    "build": "",
+    "ci": "",
+    "docs": "",
+    "feat": "origin/1.1.x",
+    "fix": "",
+    "perf": "",
+    "refactor": "",
+    "style": "",
+    "test": "",
+    "tool": ""
+  },
+  "branches": [
+    "origin/master",
+    "origin/1.1.x"
   ]
 }

scripts/validate-commit-message/validate-commit-message.js

@@ -24,33 +24,35 @@ const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
 const { packages, tools } = require('../../lib/packages');
 const PATTERN = /^(revert\: )?(\w+)(?:\(([^)]+)\))?\: (.+)$/;
 
-module.exports = function(commitSubject) {
+module.exports = function(commitSubject, branch) {
   if (commitSubject.length > config['maxLength']) {
     error(`The commit message is longer than ${config['maxLength']} characters`, commitSubject);
     return false;
   }
 
   const match = PATTERN.exec(commitSubject);
   if (!match || match[2] === 'revert') {
-    error(
-        'The commit message does not match the format of "<type>(<scope>): <subject> OR revert: type(<scope>): <subject>"',
-        commitSubject);
+    error('The commit message does not match the format of "<type>(<scope>): <subject> '
+        + 'OR revert: type(<scope>): <subject>"', commitSubject);
     return false;
   }
 
   const type = match[2];
-  if (config['types'].indexOf(type) === -1) {
-    error(
-        `${type} is not an allowed type.\n => TYPES: ${config['types'].join(', ')}`, commitSubject);
+  const types = Object.keys(config['types']);
+  if (!(type in types)) {
+    error(`${type} is not an allowed type.\n => TYPES: ${types.join(', ')}`, commitSubject);
+    return false;
+  }
+  if (types[type] !== "" && types[type] !== branch) {
+    error(`${type} is not allowed to be on branch ${branch}.`, commitSubject);
     return false;
   }
 
   const scope = match[3];
   const allScopes = Object.keys(packages).concat(Object.keys(tools));
 
   if (scope && !allScopes.includes(scope)) {
-    error(
-        `"${scope}" is not an allowed scope.\n => SCOPES: ${config['scopes'].join(', ')}`,
+    error(`"${scope}" is not an allowed scope.\n => SCOPES: ${allScopes.join(', ')}`,
         commitSubject);
     return false;
   }