Breaking changes

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 strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a schema preview.

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 2022-10-01

• Breaking A change will be made to UpdateProjectNextItemFieldInput.fieldWithSettingId.

  Description:

  fieldWithSettingId will be removed. Use fieldConstraintId instead

  Reason:

  Renamed to fieldConstraintId to improve naming consistency.

Changes scheduled for 2022-07-01

• Breaking A change will be made to Query.sponsorables.dependencyEcosystem.

  Description:

  dependencyEcosystem will be removed. Use the ecosystem argument instead.

  Reason:

  The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

• Breaking A change will be made to Enterprise.userAccounts.

  Description:

  userAccounts will be removed. Use the Enterprise.members field instead.

  Reason:

  The Enterprise.userAccounts field is being removed.

• Breaking A change will be made to AddPullRequestToMergeQueueInput.branch.

  Description:

  branch will be removed.

  Reason:

  PRs are added to the merge queue for the base branch, the branch argument is now a no-op

Changes scheduled for 2022-04-01

• Breaking A change will be made to Repository.defaultMergeQueue.

  Description:

  defaultMergeQueue will be removed. Use Repository.mergeQueue instead.

  Reason:

  defaultMergeQueue will be removed.

Changes scheduled for 2021-10-01

• Breaking A change will be made to ReactionGroup.users.

  Description:

  users will be removed. Use the reactors field instead.

  Reason:

  Reactors can now be mannequins, bots, and organizations.

Changes scheduled for 2021-06-21

• Breaking A change will be made to PackageType.DOCKER.

  Description:

  DOCKER will be removed.

  Reason:

  DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

Changes scheduled for 2021-01-01

• Breaking A change will be made to MergeStateStatus.DRAFT.

  Description:

  DRAFT will be removed. Use PullRequest.isDraft instead.

  Reason:

  DRAFT state will be removed from this enum and isDraft should be used instead

• Breaking A change will be made to EnterpriseOutsideCollaboratorEdge.isUnlicensed.

  Description:

  isUnlicensed will be removed.

  Reason:

  All outside collaborators consume a license

• Breaking A change will be made to EnterpriseMemberEdge.isUnlicensed.

  Description:

  isUnlicensed will be removed.

  Reason:

  All members consume a license

Changes scheduled for 2020-10-01

• Breaking A change will be made to Sponsorship.sponsor.

  Description:

  sponsor will be removed. Use Sponsorship.sponsorEntity instead.

  Reason:

  Sponsorship.sponsor will be removed.

• Breaking A change will be made to PullRequest.timeline.

  Description:

  timeline will be removed. Use PullRequest.timelineItems instead.

  Reason:

  timeline will be removed

• Breaking A change will be made to Issue.timeline.

  Description:

  timeline will be removed. Use Issue.timelineItems instead.

  Reason:

  timeline will be removed

Changes scheduled for 2020-07-01

• Breaking A change will be made to EnterprisePendingMemberInvitationEdge.isUnlicensed.

  Description:

  isUnlicensed will be removed.

  Reason:

  All pending members consume a license

Changes scheduled for 2020-04-01

• Breaking A change will be made to Sponsorship.maintainer.

  Description:

  maintainer will be removed. Use Sponsorship.sponsorable instead.

  Reason:

  Sponsorship.maintainer will be removed.

Changes scheduled for 2020-01-01

• Breaking A change will be made to UnassignedEvent.user.

  Description:

  user will be removed. Use the assignee field instead.

  Reason:

  Assignees can now be mannequins.

• Breaking A change will be made to EnterpriseBillingInfo.seats.

  Description:

  seats will be removed. Use EnterpriseBillingInfo.totalLicenses instead.

  Reason:

  seats will be replaced with totalLicenses to provide more clarity on the value being returned

• Breaking A change will be made to EnterpriseBillingInfo.availableSeats.

  Description:

  availableSeats will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.

  Reason:

  availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned

• Breaking A change will be made to AssignedEvent.user.

  Description:

  user will be removed. Use the assignee field instead.

  Reason:

  Assignees can now be mannequins.

Changes scheduled for 2019-04-01

• Breaking A change will be made to LegacyMigration.uploadUrlTemplate.

  Description:

  uploadUrlTemplate will be removed. Use uploadUrl instead.

  Reason:

  uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.