Breaking changes

Learn about recent and upcoming breaking changes to the GitHub GraphQL API.

In this article

About breaking changes

Breaking changes are any changes that might require action from our integrators. We divide these changes into two categories:

  • Breaking: Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
  • Dangerous: Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.

We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.

Changes scheduled for 2027-01-01

  • Breaking A change will be made to CheckAnnotation.databaseId.
    Description:

    databaseId will be removed. Use fullDatabaseId instead.

    Reason:

    databaseId will be removed because it does not support 64-bit signed integer identifiers.

  • Breaking A change will be made to Artifact.databaseId.
    Description:

    databaseId will be removed. Use fullDatabaseId instead.

    Reason:

    databaseId will be removed because it does not support 64-bit signed integer identifiers.

Changes scheduled for 2026-10-01

  • Breaking A change will be made to User.viewerRelevantRepositories.
    Description:

    viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead.

    Reason:

    viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.

  • Breaking A change will be made to CopilotAgentTask.type.
    Description: