Skip to content

github

code_context_agent.issues.github

GitHub issue provider using gh CLI.

GitHubIssueProvider

Bases: IssueProvider

Fetch GitHub issues using the gh CLI (deterministic, not model-invoked).

fetch 

fetch(ref)

Fetch a GitHub issue.

Parameters:

Name Type Description Default
ref str

Issue reference. Formats: - "1694" (issue number in current repo) - "owner/repo#1694" (full reference)

 required

Returns:

Type Description
Issue

Normalized Issue object.
Source code in src/code_context_agent/issues/github.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def fetch(self, ref: str) -> Issue:
    """Fetch a GitHub issue.

    Args:
        ref: Issue reference. Formats:
            - "1694" (issue number in current repo)
            - "owner/repo#1694" (full reference)

    Returns:
        Normalized Issue object.
    """
    # Parse reference
    repo_flag = []
    match = re.match(r"^([^#]+)#(\d+)$", ref)
    if match:
        repo_flag = ["--repo", match.group(1)]
        issue_number = match.group(2)
    else:
        issue_number = ref

    cmd = [
        "gh",
        "issue",
        "view",
        issue_number,
        "--json",
        "title,body,state,labels,comments,url",
        *repo_flag,
    ]

    try:
        result = subprocess.run(
            cmd,
            capture_output=True,
            text=True,
            timeout=30,
        )
    except (subprocess.SubprocessError, OSError) as e:
        raise RuntimeError(f"Failed to fetch GitHub issue {ref}: {e}") from e

    if result.returncode != 0:
        raise RuntimeError(
            f"gh issue view failed (exit {result.returncode}): {result.stderr.strip()}",
        )

    data = json.loads(result.stdout)

    comments = [
        IssueComment(
            author=c.get("author", {}).get("login", "unknown"),
            body=c.get("body", ""),
            created_at=c.get("createdAt", ""),
        )
        for c in data.get("comments", [])
    ]

    labels = [label.get("name", "") for label in data.get("labels", [])]

    return Issue(
        provider="github",
        ref=f"gh:{ref}",
        title=data.get("title", ""),
        body=data.get("body", ""),
        state=data.get("state", "unknown"),
        labels=labels,
        comments=comments,
        url=data.get("url"),
    )

parse_issue_ref 

parse_issue_ref(ref_string)

Parse a --issue flag value into (provider, ref).

Parameters:

Name Type Description Default
ref_string str

e.g., "gh:1694", "gh:owner/repo#1694", "jira:PROJ-123"

 required

Returns:

Type Description
tuple[str, str]

Tuple of (provider_name, reference)

Raises:

Type Description
ValueError

If format is not recognized
Source code in src/code_context_agent/issues/github.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def parse_issue_ref(ref_string: str) -> tuple[str, str]:
    """Parse a --issue flag value into (provider, ref).

    Args:
        ref_string: e.g., "gh:1694", "gh:owner/repo#1694", "jira:PROJ-123"

    Returns:
        Tuple of (provider_name, reference)

    Raises:
        ValueError: If format is not recognized
    """
    if ":" not in ref_string:
        raise ValueError(
            f"Invalid issue reference: {ref_string}. Expected format: provider:ref (e.g., gh:1694, gh:owner/repo#1694)",
        )
    provider, ref = ref_string.split(":", 1)
    return provider.lower(), ref