Query Workflows

1#!/bin/bash
2set +o histexpand
3
4# Query GitHub Actions workflows with perPage pagination support.
5#
6# Usage: ./query-workflows.sh [OPTIONS]
7#
8# Options:
9#   --owner OWNER      Repository owner (required)
10#   --repo REPO        Repository name (required)
11#   --per-page N       Results per page: 1-100 (default: 10)
12#   --page N           Page number (default: 1)
13#
14# Alternatively, inputs can be provided as environment variables using the
15# mcp-scripts INPUT_* convention (INPUT_OWNER, INPUT_REPO, INPUT_PERPAGE,
16# INPUT_PAGE). INPUT_PER_PAGE is also accepted for backward compatibility.
17# CLI arguments take precedence over environment variables.
18#
19# Calls the GitHub REST API:
20#   GET /repos/{owner}/{repo}/actions/workflows?per_page={n}&page={n}
21#
22# Returns JSON:
23#   { "total_count": N, "per_page": N, "page": N, "workflows": [...] }
24
25set -e
26
27# Defaults: pick up INPUT_* env vars (mcp-scripts convention) or fall back to
28# hardcoded defaults; CLI flags below will override.
29# INPUT_PERPAGE (camelCase perPage) is preferred; INPUT_PER_PAGE accepted for
30# backward compatibility with callers using the old snake_case convention.
31OWNER="${INPUT_OWNER:-}"
32REPO="${INPUT_REPO:-}"
33PER_PAGE="${INPUT_PERPAGE:-${INPUT_PER_PAGE:-10}}"
34PAGE="${INPUT_PAGE:-1}"
35
36while [[ $# -gt 0 ]]; do
37    case $1 in
38        --owner)
39            OWNER="$2"
40            shift 2
41            ;;
42        --repo)
43            REPO="$2"
44            shift 2
45            ;;
46        --per-page)
47            PER_PAGE="$2"
48            shift 2
49            ;;
50        --page)
51            PAGE="$2"
52            shift 2
53            ;;
54        *)
55            echo "Unknown option: $1" >&2
56            exit 1
57            ;;
58    esac
59done
60
61if [[ -z "$OWNER" ]]; then
62    echo '{"error": "owner is required"}' >&2
63    exit 1
64fi
65
66if [[ -z "$REPO" ]]; then
67    echo '{"error": "repo is required"}' >&2
68    exit 1
69fi
70
71if ! [[ "$PER_PAGE" =~ ^[0-9]+$ ]] || [[ "$PER_PAGE" -lt 1 ]] || [[ "$PER_PAGE" -gt 100 ]]; then
72    echo '{"error": "per_page must be between 1 and 100"}' >&2
73    exit 1
74fi
75
76RESPONSE=$(gh api "repos/${OWNER}/${REPO}/actions/workflows?per_page=${PER_PAGE}&page=${PAGE}")
77
78echo "$RESPONSE" | jq \
79    --argjson per_page "$PER_PAGE" \
80    --argjson page "$PAGE" \
81    '{
82        total_count: .total_count,
83        per_page: $per_page,
84        page: $page,
85        workflows: [.workflows[] | {id, node_id, name, path, state, created_at, updated_at, url, html_url, badge_url}]
86    }'