\!fixup Start preparing annotations by the script itself

.pre-commit-config.yaml

@@ -118,6 +118,7 @@ repos:
       - id: pylint
         additional_dependencies:
           - regex
+          - PyGithub
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.7.1
     hooks:
@@ -130,4 +131,4 @@ repos:
           - --show-error-codes
           - --show-error-context
           - --disable-error-code=name-defined
-        additional_dependencies: [tkcalendar>=1.5.0, types-pytz, regex]
+        additional_dependencies: [tkcalendar>=1.5.0, types-pytz, regex, PyGithub]

logToCs.py

@@ -87,6 +87,38 @@ def convert_text_to_checkstyle(text, root_path=None):
     return ET.tostring(root, encoding="utf_8").decode("utf_8")
 
 
+def github_annotate(items):
+    """
+    Record github annotations for the items.
+
+    throws ImportError if the github module is not available.
+    """
+    if not hasattr(github_annotate, "initialized"):
+        # Initialise github annotation submission
+        github_annotate.initialized = True
+        from github import Github
+
+        # Create Github instance
+        g = Github(access_token)
+
+        # Get the repository
+        repo = g.get_repo(f'{owner}/{repo_name}')
+
+        # Create a check run
+        github_annotate.check_run = repo.get_commit(commit_sha).create_check_run(
+          'YourCheckName',
+          'in_progress',
+        )
+
+    github_annotate.check_run.create_annotation(
+        path='path/to/file',
+        start_line=10,
+        end_line=10,
+        annotation_level='warning',  # or 'failure', 'notice'
+        message='This is a warning message',
+    )
+
+
 ANY_REGEX = r".*?"
 FILE_REGEX = r"\s*(?P<file_name>\S.*?)\s*?"
 FILEGROUP_REGEX = r"\s*(?P<file_group>\S.*?)\s*?"