Skip to content

cli

get_latest_release(token, owner, repo)

Retrieve the latest release for a repo.

Parameters:

Name Type Description Default
token str

A Github PAT.

 required
owner str

The owner of the repo.

 required
repo str

The name of the repo.

 required

Returns:

Type Description
OneOf[Issue, str]

The latest release.
Source code in m/github/cli.py 
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
83
84
def get_latest_release(
    token: str,
    owner: str,
    repo: str,
) -> OneOf[Issue, str]:
    """Retrieve the latest release for a repo.

    Args:
        token: A Github PAT.
        owner: The owner of the repo.
        repo: The name of the repo.

    Returns:
        The latest release.
    """
    query = """query ($owner: String!, $repo: String!) {
      repository(owner:$owner, name:$repo) {
         releases(last: 1, orderBy: {field: CREATED_AT, direction: ASC}) {
            nodes {
                name
                tagName
                publishedAt
            }
        }
      }
    }"""
    variables = {'owner': owner, 'repo': repo}
    return one_of(
        lambda: [
            tag_name
            for res in graphql(token, query, variables)
            for releases in get(res, 'repository.releases.nodes')
            for tag_name in _get_latest_release(releases)
        ],
    )

get_pr_info(token, owner, repo, pr_number, file_count)

Retrieve the information of the given Github PR.

Parameters:

Name Type Description Default
token str

A Github PAT.

 required
owner str

The owner of the repo.

 required
repo str

The name of the repo.

 required
pr_number int

The pull request number in question.

 required
file_count int

The maximum number of files in the pr to retrieve.

 required

Returns:

Type Description
OneOf[Issue, Any]

The pull request information.
Source code in m/github/cli.py 
11
12
13
14
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
def get_pr_info(
    token: str,
    owner: str,
    repo: str,
    pr_number: int,
    file_count: int,
) -> OneOf[Issue, Any]:
    """Retrieve the information of the given Github PR.

    Args:
        token: A Github PAT.
        owner: The owner of the repo.
        repo: The name of the repo.
        pr_number: The pull request number in question.
        file_count: The maximum number of files in the pr to retrieve.

    Returns:
        The pull request information.
    """
    query = create_ci_query(
        pr_number,
        include_commit=False,
        include_release=False,
    )
    variables = {
        'owner': owner,
        'repo': repo,
        'pr': pr_number,
        'fc': file_count,
    }
    return one_of(
        lambda: [
            pr_info
            for res in graphql(token, query, variables)
            for pr_info in get(res, 'repository.pullRequest')
        ],
    )