Add: Add GitHub script for displaying workflow runs

pontos/github/api/workflows.py

@@ -136,7 +136,7 @@ def get_workflow_runs(
                 example `main.yml`.
             actor: Only return workflow runs of this user ID.
             branch: Only return workflow runs for a specific branch.
-            event: Only returns workflows runs triggered by the event specified.
+            event: Only return workflow runs triggered by the event specified.
                 For example, `push`, `pull_request` or `issue`.
                 For more information, see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows.
             status: Only return workflow runs with the check run status or

scripts/github/workflow-runs.py

@@ -0,0 +1,92 @@
+# Copyright (C) 2022 Greenbone Networks GmbH
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from argparse import ArgumentParser, Namespace
+
+from rich.console import Console
+from rich.table import Table
+
+from pontos.github.api import GitHubAsyncRESTApi
+
+
+def add_script_arguments(parser: ArgumentParser) -> None:
+    parser.add_argument(
+        "--actor", help="Only return workflow runs of this user ID."
+    )
+    parser.add_argument(
+        "--branch", help="Only return workflow runs for a specific branch."
+    )
+    parser.add_argument(
+        "--event",
+        help="Only return workflow runs triggered by the event specified. "
+        "For example, `push`, `pull_request` or `issue`.",
+    )
+    parser.add_argument(
+        "--status",
+        help="Only return workflow runs with the status or conclusion "
+        "specified.",
+    )
+    parser.add_argument(
+        "--created",
+        help="Only returns workflow runs created within the given date-time "
+        "range.",
+    )
+    parser.add_argument("repository")
+    parser.add_argument(
+        "workflow",
+        help="Workflow ID or workflow file name. For example `main.yml`.",
+    )
+
+
+async def github_script(api: GitHubAsyncRESTApi, args: Namespace) -> int:
+    table = Table()
+    table.add_column("Name")
+    table.add_column("ID")
+    table.add_column("URL")
+    table.add_column("Branch")
+    table.add_column("Event")
+    table.add_column("Status")
+    table.add_column("Updated")
+    table.add_column("Actor")
+
+    count = 0
+    async for run in api.workflows.get_workflow_runs(
+        args.repository,
+        args.workflow,
+        actor=args.actor,
+        branch=args.branch,
+        event=args.event,
+        status=args.status,
+        created=args.created,
+    ):
+        table.add_row(
+            run.name,
+            str(run.id),
+            run.html_url,
+            run.head_branch,
+            run.event,
+            run.conclusion,
+            run.updated_at,
+            run.actor.login,
+        )
+        count += 1
+
+    console = Console()
+    console.print(table)
+
+    print(f"{count} workflow runs.")
+    return 0