feat: add options to pass custom regex to conventional-commits-parser

README.md

@@ -65,6 +65,13 @@ The action works without configuration, however you can provide options for cust
             The subject "{subject}" found in the pull request title "{title}"
             didn't match the configured pattern. Please ensure that the subject
             doesn't start with an uppercase character.
+          # Configure custom regex that will be passed to conventional-commits-parser.
+          # This can be used to specify different required format of the title.
+          # The correspondence is used to define what capturing group of headerPattern captures what header part.
+          # The example values are the default.
+          # For more details see: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#headerpattern
+          headerPattern: '^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$'
+          headerPatternCorrespondence: type, scope, subject
           # For work-in-progress PRs you can typically use draft pull requests 
           # from GitHub. However, private repositories on the free plan don't have 
           # this option and therefore this action allows you to opt-in to using the 

action.yml

@@ -23,6 +23,12 @@ inputs:
   subjectPatternError:
     description: "If `subjectPattern` is configured, you can use this property to override the default error message that is shown when the pattern doesn't match. The variables `subject` and `title` can be used within the message."
     required: false
+  headerPattern:
+    description: "Configure custom regex that will be passed to conventional-commits-parser. For more details see: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#headerpattern"
+    required: false
+  headerPatternCorrespondence:
+    description: "If `headerPattern` is configured, you can use this property to also configure which RegEx groups match what part of the semantic commit."
+    required: false
   wip:
     description: "For work-in-progress PRs you can typically use draft pull requests from Github. However, private repositories on the free plan don't have this option and therefore this action allows you to opt-in to using the special '[WIP]' prefix to indicate this state. This will avoid the validation of the PR title and the pull request checks remain pending. Note that a second check will be reported if this is enabled."
     required: false

src/index.js

@@ -12,6 +12,8 @@ module.exports = async function run() {
       wip,
       subjectPattern,
       subjectPatternError,
+      headerPattern,
+      headerPatternCorrespondence,
       validateSingleCommit,
       validateSingleCommitMatchesPrTitle,
       githubBaseUrl,
@@ -66,7 +68,9 @@ module.exports = async function run() {
           scopes,
           requireScope,
           subjectPattern,
-          subjectPatternError
+          subjectPatternError,
+          headerPattern,
+          headerPatternCorrespondence
         });
 
         if (validateSingleCommit) {
@@ -105,7 +109,9 @@ module.exports = async function run() {
                 scopes,
                 requireScope,
                 subjectPattern,
-                subjectPatternError
+                subjectPatternError,
+                headerPattern,
+                headerPatternCorrespondence
               });
             } catch (error) {
               throw new Error(

src/parseConfig.js

@@ -28,6 +28,18 @@ module.exports = function parseConfig() {
     );
   }
 
+  let headerPattern;
+  if (process.env.INPUT_HEADERPATTERN) {
+    headerPattern = ConfigParser.parseString(process.env.INPUT_HEADERPATTERN);
+  }
+
+  let headerPatternCorrespondence;
+  if (process.env.INPUT_HEADERPATTERNCORRESPONDENCE) {
+    headerPatternCorrespondence = ConfigParser.parseString(
+      process.env.INPUT_HEADERPATTERNCORRESPONDENCE
+    );
+  }
+
   let wip;
   if (process.env.INPUT_WIP) {
     wip = ConfigParser.parseBoolean(process.env.INPUT_WIP);
@@ -64,6 +76,8 @@ module.exports = function parseConfig() {
     wip,
     subjectPattern,
     subjectPatternError,
+    headerPattern,
+    headerPatternCorrespondence,
     validateSingleCommit,
     validateSingleCommitMatchesPrTitle,
     githubBaseUrl,

src/validatePrTitle.js

@@ -7,11 +7,25 @@ const defaultTypes = Object.keys(conventionalCommitTypes.types);
 
 module.exports = async function validatePrTitle(
   prTitle,
-  {types, scopes, requireScope, subjectPattern, subjectPatternError} = {}
+  {
+    types,
+    scopes,
+    requireScope,
+    subjectPattern,
+    subjectPatternError,
+    headerPattern,
+    headerPatternCorrespondence
+  } = {}
 ) {
   if (!types) types = defaultTypes;
 
   const {parserOpts} = await conventionalCommitsConfig();
+  if (headerPattern) {
+    parserOpts.headerPattern = headerPattern;
+  }
+  if (headerPatternCorrespondence) {
+    parserOpts.headerCorrespondence = headerPatternCorrespondence;
+  }
   const result = parser(prTitle, parserOpts);
 
   function printAvailableTypes() {