Merge pull request #37 from ccdc-opensource/SYS-8303-co-pilot-autofix

Sys-8303 co-pilot autofix

Author: mmaharjan-ccdc

README.md

@@ -14,8 +14,8 @@ The commit will be flagged if it includes certain text files with:
 * Certain C++ #include patterns and std::exception
 
 The commit will also be flagged if the commit message does not include a Jira
-ID (unless marked with NO_JIRA), or if the size of new or modiffied files
-exceeds a threshold.
+ID (unless marked with NO_JIRA or a Copilot Autofix co-author line), or if the
+size of new or modified files exceeds a threshold.
 
 
 # Github action

main/githooks.py

@@ -25,6 +25,11 @@
 LARGE_FILE_MARKER = 'LARGE_FILE'
 # No jira marker in commit message
 NO_JIRA_MARKER = 'NO_JIRA'
+# Copilot Autofix co-author in commit message description
+copilot_autofix_coauthor_pattern = re.compile(
+    r'^Co-authored-by:\s+.*<\d+\+Copilot@users\.noreply\.github\.com>$',
+    re.MULTILINE,
+)
 # A marker to represent it's a change we don't want to commit
 DO_NOT_COMMIT = 'do not' + ' commit'
 # Check file content if it has these extensions
@@ -854,11 +859,16 @@ def check_commit_msg(message, files, repo):
         # Do not check for JIRA in opensource repo as we don't want to require external contributors to do this
         return 0
 
-    if NO_JIRA_MARKER not in message:
-        if jira_id_pattern.search(message) is None:
-            _fail('Every commit should contain a Jira issue ID or the text '
-                  f'{NO_JIRA_MARKER}')
-            return 1
+    if (
+        NO_JIRA_MARKER not in message
+        and copilot_autofix_coauthor_pattern.search(message) is None
+        and jira_id_pattern.search(message) is None
+    ):
+        _fail(
+            'Every commit should contain a Jira issue ID, '
+            f'{NO_JIRA_MARKER}, or be a Copilot Autofix commit'
+        )
+        return 1
 
     for filename in files:
         size = Path(filename).stat().st_size / 1024**2
@@ -904,6 +914,11 @@ def _test(input, is_good=True):
         _test('ABC-1234')
         _test('Some changes for ABC-1234 ticket')
         _test('Trivial change NO_JIRA')
+        _test(
+            'Trivial change\n\n'
+            'Co-authored-by: Copilot Autofix powered by AI '
+            '<175728472+Copilot@users.noreply.github.com>'
+        )
         _test("Merge branch 'main' into my_branch")
         _test("Merge branch 'branch_1' into branch_2")
         _test("Merge branch 'jira_pyapi_123_abc' of github.com:ccdc-confidential/cpp-apps-main into jira_pyapi_123_abc")