Release 2.0

# Changes and Updates
- Support private repos
- Change the configuration file from .validationconfig to .github folder

# Breaking Changes
- Configuration changes

Author: sumits-systango

README.md

@@ -1,4 +1,4 @@
-# commit-message-validator
+# Commit Message Lint
 Github app to validate commit message and pull request title on a pull request
 
 ## Description
@@ -7,19 +7,19 @@ This app runs a format check on commit messages and pull request title on the cr
 For example, let's say you specify that a commit message should have a format `DDD:message`. Here D stand for numeric digit. The app checks if the commit message follows this format. If all the commit messages follow this format, the check returns successful, otherwise failure. The reviewer can then decide if they want to go ahead with the code merge.
 
 ### App URL
-https://github.com/apps/commit-message-validator
+https://github.com/apps/commit-message-lint
 
 ## Installation
 
 Use the Github's app section or above URL to install the app to your repository.
 
-## Setup
+## Configuration
 
-You would need to add a configuration file named `.validationconfig` to the root of your repository. The contents of that file will be:
+You would need to add a configuration folder named `.github` at the root of your repository. The folder should contain a file named `config.yml`. This file will serve as the configuration and the contents of that file will be:
 
 ```
-PR_TITLE_REGEX=<PR Title Regex>
-COMMIT_MESSAGE_REGEX=<Commit Message Regex>
+PR_TITLE_REGEX: <PR Title Regex>
+COMMIT_MESSAGE_REGEX: <Commit Message Regex>
 ```
 
 ## Usage

controllers/pullRequest.js

@@ -1,25 +1,32 @@
 const { checkRegex } = require('../utilities/regexUtil');
-const { getRegexFromConfig } = require('../helpers/config');
 const { createCheckSuite, createCheckRun, listCheckSuite } = require('../helpers/checks');
 const { listCommitsOfPullRequest } = require('../helpers/pullRequest');
 const defaultJson = require('../default.json');
+const mergeCommitRegex = defaultJson.REGEX.MERGE_COMMIT_REGEX;
 const conclusionStatus = defaultJson.conclusion_status;
 const messages = defaultJson.messages;
 const checkRunStatusCompleted = defaultJson.CHECK_RUN_STATUS_COMPLETED;
 const checkRunName = defaultJson.CHECK_RUN_NAME;
 const outputTitleSuccess = defaultJson.output_title_success;
 const outputTitleFail = defaultJson.output_title_fail;
 
-module.exports.commitAndTitleValidator = async (app, context) => {
+/**
+ * Commit messages and PR title Validator
+ * @param {Object} app
+ * @param {Object} context
+ * @param {Object} configuration
+ */
+module.exports.commitAndTitleValidator = async (app, context, configuration) => {
     try {
+        const prTitleRegex = (configuration && configuration.PR_TITLE_REGEX) ? configuration.PR_TITLE_REGEX: '';
+        const commitTitleRegex = (configuration && configuration.COMMIT_MESSAGE_REGEX) ? configuration.COMMIT_MESSAGE_REGEX : '';
         let owner = context.payload.repository.owner.login;
         let repository = context.payload.repository.name;
         let pullRequestTitle = context.payload.pull_request.title;
         let pullNumber = context.payload.number;
-        let regexData = await getRegexFromConfig(app, owner, repository, process.env.REGEX_CONFIG_FILE_NAME);
         // find commits
         let commits = await listCommitsOfPullRequest(context, owner, repository, pullNumber);
-        let result = checkMessagesFormat(pullRequestTitle, commits.data, regexData.prTitle, regexData.commitMsg);
+        let result = checkMessagesFormat(pullRequestTitle, commits.data, prTitleRegex, commitTitleRegex);
         if (result && result.commitIds && Array.isArray(result.commitIds) && result.commitIds.length) {
             for (let index = 0; index < result.commitIds.length; index++) {
                 const commitId = result.commitIds[index];
@@ -44,8 +51,8 @@ module.exports.commitAndTitleValidator = async (app, context) => {
  * check Messages Format
  * @param {String} pullRequestTitle 
  * @param {Array} commits
- * @param {Object} prTitleRegex
- * @param {Object} commitMsgRegex
+ * @param {String} prTitleRegex
+ * @param {String} commitMsgRegex
  */
 function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgRegex) {
     try {
@@ -65,7 +72,6 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgR
          * pull Request Title check : starts
          */
         // pull request title format
-        let mergePattern = /^(Merge pull request)/;
         if (checkRegex(pullRequestTitle, prTitleRegex)) {
             pullReqTitleStatus = true;
             pullReqTitleStatusMsg = messages.valid_pull_request_message;
@@ -87,7 +93,7 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgR
                 const element = commits[index];
                 const commitMessage = element.commit.message;
                 commitIds.push(commits[index].sha);
-                if (!checkRegex(commitMessage, commitMsgRegex) && !checkRegex(commitMessage, mergePattern)) {
+                if (!checkRegex(commitMessage, commitMsgRegex) && !checkRegex(commitMessage, mergeCommitRegex)) {
                     invalidCommitsCount++;
                     commitMsgStatus = false;
                     commitMsgStatusMsg = messages.invalid_commit_message;
@@ -120,15 +126,15 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgR
                 summary: `${pullReqTitleStatusMsg}<br/>${commitMsgStatusMsg}<br/>${invalidCommits}<br/>`
             };
             let status = checkRunStatusCompleted;
-            if ((!prTitleRegex || !prTitleRegex.regexPattern) && (!commitMsgRegex || !commitMsgRegex.regexPattern)) {
+            if (!prTitleRegex && !commitMsgRegex) {
                 // pull request and commit message configration regex not set
                 output.title = `${messages.pr_and_commit_message_configuration_not_set}`;
                 output.summary = `${messages.pr_and_commit_message_configuration_not_set}<br/>`;
-            } else if (!commitMsgRegex || !commitMsgRegex.regexPattern) {
+            } else if (!commitMsgRegex) {
                 // commit message configration regex not set
                 output.title = `${messages.commit_message_configuration_not_set}`;
                 output.summary = `${pullReqTitleStatusMsg}<br/>${messages.commit_message_configuration_not_set}<br/>`;
-            } else if (!prTitleRegex || !prTitleRegex.regexPattern) {
+            } else if (!prTitleRegex) {
                 // pull request configration regex not set
                 output.title = `${messages.pr_configuration_not_set}`;
                 output.summary = `${messages.pr_configuration_not_set}<br/>${commitMsgStatusMsg}<br/>${invalidCommits}<br/>`;

default.json

@@ -16,20 +16,23 @@
         "single_other_invalid_message": "other message is invalid",
         "pr_configuration_not_set": "Pull request title format is not configured",
         "commit_message_configuration_not_set": "Commit message format is not configured",
-        "pr_and_commit_message_configuration_not_set": "Pull request title and commit message format are not configured"
+        "pr_and_commit_message_configuration_not_set": "Pull request title and commit message format are not configured",
+        "home_page_message": "Commit Message Lint App"
     },
     "CHECK_RUN_STATUS_COMPLETED": "completed",
-    "CHECK_RUN_NAME": "commit message validator",
+    "CHECK_RUN_NAME": "Commit Message Lint",
     "output_title_success": "Message validation passed!!!",
     "output_title_fail": "Message validation failed!!!",
     "INVALID_COMMIT_LIMIT": 3,
-    "USER_AGENT": "commit-message-validator-app",
+    "USER_AGENT": "commit-message-lint-app",
     "invalid_commit_list": {
         "commit_id": "sha:",
         "commit_message": "message:"
     },
     "REGEX": {
-        "PR_TITLE_REGEX": "PR_TITLE_REGEX=",
-        "COMMIT_MESSAGE_REGEX": "COMMIT_MESSAGE_REGEX="
+        "MERGE_COMMIT_REGEX": "/^(Merge pull request)/"
+    },
+    "events": {
+        "PULL_REQUEST_OPEN": "pull_request.opened"
     }
 }

index.js

@@ -1,22 +1,32 @@
 const { commitAndTitleValidator } = require('./controllers/pullRequest');
+const { messages, events } = require('./default.json');
 const express = require('express');
 const expressApp = express();
+const path = require('path');
+const publicDirectory = `${__dirname}/public`;
+
 /**
  * This is the main entrypoint to your Probot app
  * @param {import('probot').Application} app
  */
+const ConfigFilename = process.env.REGEX_CONFIG_FILE_NAME;
+
 module.exports = async app => {
   /**
-   * pull request event listener
+   * Created pull request event listener
    */
-  app.on('pull_request.opened', async (context) => {
-    await commitAndTitleValidator(app, context);
+  app.on(events.PULL_REQUEST_OPEN, async (context) => {
+    const configuration = await context.config(ConfigFilename);
+    await commitAndTitleValidator(app, context, configuration);
   });
 
   expressApp.get('/', (req, res) => {
-    res.send('Commit Validator Message App');
+    res.send(messages.home_page_message);
+  });
+
+  expressApp.get('/privacy', (req, res) => {
+    res.sendFile(path.join(`${publicDirectory}/privacy.html`));
   });
 
   app.router.use('/', expressApp);
 };
-

utilities/regexUtil.js

@@ -1,13 +1,18 @@
+/**
+ * Match input string with regex
+ * @param {String} inputString
+ * @param {String} pattern
+ */
 module.exports.checkRegex = (inputString, pattern) => {
     try {
         let patt = '';
         let status = false;
-        if (pattern && pattern.regexPattern && pattern.flags) {
-            patt = new RegExp(pattern.regexPattern, pattern.flags);
+        if (pattern) {
+            let regexObj = module.exports.regexExtractor(pattern);
+            patt = new RegExp(regexObj.regexPattern, regexObj.flags);
             status = patt.test(inputString);
         } else {
-            patt = new RegExp(pattern);
-            status = patt.test(inputString);
+            status = true;
         }
         return status;
     } catch (error) {