Added branch argument

Author: tekktrik

tools/ci_status.py

@@ -29,22 +29,27 @@
 def run_gh_rest_check(
     lib_repo: Repository,
     user: Optional[str] = None,
+    branch: Optional[str] = "main",
     workflow_filename: Optional[str] = "build.yml",
 ) -> str:
     """Uses ``PyGithub`` to check the CI status of a repository
 
     :param Repository lib_repo: The repo as a github.Repository.Repository object
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; the default is ``"main"``
     :param str|None workflow_filename: The filename of the workflow; if `None` is
-        provided, any workflow name is acceptable; the default is `"build.yml"`
+        provided, any workflow name is acceptable; the default is ``"build.yml"``
     :return: The requested runs conclusion
     :rtype: str
     """
 
     arg_dict = {}
     if user is not None:
         arg_dict["actor"] = user
+    if branch is not None:
+        arg_dict["branch"] = branch
 
     workflow: Workflow = lib_repo.get_workflow(workflow_filename)
     workflow_runs = workflow.get_runs(**arg_dict)
@@ -54,6 +59,7 @@ def run_gh_rest_check(
 def check_build_status(
     lib_repo: Repository,
     user: Optional[str] = None,
+    branch: Optional[str] = "main",
     workflow_filename: Optional[str] = "build.yml",
     debug: bool = False,
 ) -> Optional[str]:
@@ -63,6 +69,8 @@ def check_build_status(
     :param Repository lib_repo: The repo as a github.Repository.Repository object
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; the default is ``"main"``
     :param str|None workflow_filename: The filename of the workflow; if `None`
         is provided, any workflow name is acceptable; the defail is `"build.yml"`
     :param bool debug: Whether debug statements should be printed to the standard
@@ -79,7 +87,9 @@ def check_build_status(
         return True
 
     try:
-        result = run_gh_rest_check(lib_repo, user, workflow_filename) == "success"
+        result = (
+            run_gh_rest_check(lib_repo, user, branch, workflow_filename) == "success"
+        )
         if debug and not result:
             print("***", "Library", lib_repo.name, "failed the patch!", "***")
         return result
@@ -98,6 +108,7 @@ def check_build_status(
 def check_build_statuses(
     gh_token: str,
     user: Optional[str] = None,
+    branch: Optional[str] = "main",
     workflow_filename: Optional[str] = "build.yml",
     *,
     debug: bool = False,
@@ -108,6 +119,8 @@ def check_build_statuses(
     :param str gh_token: The Github token to be used for with the Github API
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; the default is ``"main"``
     :param str|None workflow_filename: The filename of the workflow; if `None` is
         provided, any workflow name is acceptable; the defail is `"build.yml"`
     :param bool debug: Whether debug statements should be printed to
@@ -118,7 +131,8 @@ def check_build_statuses(
     """
 
     return iter_remote_bundle_with_func(
-        gh_token, [(check_build_status, (user, workflow_filename), {"debug": debug})]
+        gh_token,
+        [(check_build_status, (user, branch, workflow_filename), {"debug": debug})],
     )
 
 
@@ -160,6 +174,14 @@ def save_build_statuses(
         default=None,
         help="Select a specific user that triggered the workflow",
     )
+    parser.add_argument(
+        "--branch",
+        metavar="B",
+        type=str,
+        dest="branch",
+        default="main",
+        help='Branch name; default is "main"',
+    )
     parser.add_argument(
         "--workflow",
         metavar="W",
@@ -175,7 +197,7 @@ def save_build_statuses(
     args = parser.parse_args()
 
     results = check_build_statuses(
-        args.gh_token, args.user, args.workflow, debug=args.debug
+        args.gh_token, args.user, args.branch, args.workflow, debug=args.debug
     )
     fail_list = [
         repo_name.name for repo_name, repo_results in results if not repo_results[0]