Skip to content

ci_graph_queries

commit_query(include_pr, include_author)

Build a graphql query for github.

The output of this function is meant to go inside the repository field.

Parameters:

Name Type Description Default
include_pr bool

If true, it will include pull request information.

 required
include_author bool

If true, it will include user information.

 required

Returns:

Type Description
str

A valid graphql query.
Source code in m/github/ci_graph_queries.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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
48
49
50
51
52
53
def commit_query(include_pr: bool, include_author: bool) -> str:
    """Build a graphql query for github.

    The output of this function is meant to go inside the repository
    field.

    Args:
        include_pr: If true, it will include pull request information.
        include_author: If true, it will include user information.

    Returns:
        A valid graphql query.
    """
    author = """
      author {
        name
        email
        user {
          login
        }
      }
      oid
    """ if include_author else ''
    pr = """
      associatedPullRequests(first: 1) {
        nodes {
          author {
            login
            avatarUrl(size: 50)
            ... on User {
              email
            }
          }
          number
          title
          body
          baseRefName
          baseRefOid
          headRefName
          headRefOid
          merged
        }
      }
    """ if include_pr else ''
    return f"""
      commit: object(expression: $sha) {{
        ... on Commit {{
          message
          {author}
          {pr}
        }}
      }}
    """