Skip to content

Update pipeline GraphQL schema

Problem to solve

This issue is part of the Epic to update the frontend pipeline codebase.

The CI team has a goal to migrate the pipelines table page and the individual pipeline page to use the GraphQL API. Currently, the pipeline schema does not contain all that is necessary to show what is currently displayed on those pages.

See the pipeline schema documented in our GraphQL API Resource.

Intended users

  • Frontend developers on the CI team
  • Frontend developers that need to access some pipeline data
  • Customers making their own tools that integrate with our GraphQL API and want the pipeline information

Proposal

Expose the following information in the GraphQL schema:

  • User who triggered the pipeline
  • Commit that the pipeline is running (we have the sha, but would be better to use the Commit schema)
  • A Pipeline Details schema that contains:
    • the status
    • a list of stages
    • a list of artifacts
    • a list of manual actions

Documentation

We will need to update the reference page in the GraphQL documentation.

Availability & Testing

What does success look like, and how can we measure that?

We are able to get all the same information from GraphQL that we are able to receive from the /pipelines endpoints.

Links / references

https://gitlab.com/-/graphql-explorer
https://docs.gitlab.com/ee/development/fe_guide/graphql.html
https://docs.gitlab.com/ee/api/graphql/
https://docs.gitlab.com/ee/api/graphql/reference/

Edited by Jason Yavorsky