Resolve #91 -- Add Github workflow message support for GitHub Actions

Author: codingjoe

relint/__main__.py

@@ -1,12 +1,14 @@
 import argparse
+import os
 import subprocess  # nosec
 import sys
 import warnings
 
 from rich.progress import track
 
 from relint.config import load_config
-from relint.parse import lint_file, match_with_diff_changes, parse_diff, print_culprits
+from relint.parse import lint_file, match_with_diff_changes, parse_diff, print_culprits, \
+    print_github_actions_output
 
 
 def parse_args(args=None):
@@ -90,7 +92,11 @@ def main(args=None):
         changed_content = parse_diff(output)
         matches = match_with_diff_changes(changed_content, matches)
 
-    exit_code = print_culprits(matches, args)
+    GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "true"
+    if GITHUB_ACTIONS:
+        exit_code = print_github_actions_output(matches, args)
+    else:
+        exit_code = print_culprits(matches, args)
     exit(exit_code)
 
 

relint/parse.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import collections
+import os
 
 try:
     import regex as re
@@ -93,6 +94,20 @@ def split_diff_content_by_filename(output: str) -> {str: str}:
     return content_by_filename
 
 
+def print_github_actions_output(matches, args):
+    exit_code = 0
+    for filename, test, match, line_number in matches:
+        exit_code = test.error if exit_code == 0 else exit_code
+        start_line_no = match.string[: match.start()].count("\n") + 1
+        end_line_no = match.string[: match.end()].count("\n") + 1
+
+        print(
+            f"::{'error' if test.error else 'warning'} file={filename},line={start_line_no},endLine={end_line_no},title={test.name}::{test.hint}".replace("\n", "%0A")
+        )
+    return exit_code
+
+
+
 def print_culprits(matches, args):
     exit_code = 0
     messages = []