Informationen zu Breaking Changes
Breaking Changes sind Änderungen, für die unsere Integratoren möglicherweise Maßnahmen ergreifen müssen. Diese Änderungen werden in zwei Kategorien unterteilt:
- Breaking Change: Änderungen, die dazu führen, dass bereits vorhandene Abfragen für die GraphQL-API nicht mehr funktionieren. Ein Beispiel wäre etwa das Entfernen eines Felds.
- Gefährliche Änderung: Änderungen, die nicht dazu führen, dass bereits vorhandene Abfragen nicht mehr funktionieren, aber das Laufzeitverhalten von Clients beeinflussen können. Ein Beispiel wäre etwa das Hinzufügen eines Enumerationswerts.
Bevorstehende Breaking Changes werden von uns mindestens drei Monate vor der Implementierung der Änderung am GraphQL-Schema angekündigt, damit Integratoren genügend Zeit haben, die erforderlichen Anpassungen vorzunehmen. Änderungen werden am ersten Tag eines Quartals wirksam (also am 1. Januar, 1. April, 1. Juli oder 1. Oktober). Eine am 15. Januar angekündigte Änderung wird also beispielsweise am 1. Juli vorgenommen.
Changes scheduled for 2024-07-01
- Breaking A change will be made to
TeamDiscussionComment.url.Description:urlwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussionComment.resourcePath.Description:resourcePathwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussionComment.number.Description:numberwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussionComment.discussion.Description:discussionwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussionComment.bodyVersion.Description:bodyVersionwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussionComment.authorAssociation.Description:authorAssociationwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.viewerCanPin.Description:viewerCanPinwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.url.Description:urlwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.title.Description:titlewill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.team.Description:teamwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.resourcePath.Description:resourcePathwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.number.Description:numberwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.isPrivate.Description:isPrivatewill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.isPinned.Description:isPinnedwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.commentsUrl.Description:commentsUrlwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.commentsResourcePath.Description:commentsResourcePathwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.comments.Description:commentswill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.bodyVersion.Description:bodyVersionwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
TeamDiscussion.authorAssociation.Description:authorAssociationwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
PullRequestReviewComment.databaseId.Description:databaseIdwill be removed. UsefullDatabaseIdinstead.Reason:databaseIdwill be removed because it does not support 64-bit signed integer identifiers.
- Breaking A change will be made to
PullRequestReview.databaseId.Description:databaseIdwill be removed. UsefullDatabaseIdinstead.Reason:databaseIdwill be removed because it does not support 64-bit signed integer identifiers.
- Breaking A change will be made to
PullRequest.databaseId.Description:databaseIdwill be removed. UsefullDatabaseIdinstead.Reason:databaseIdwill be removed because it does not support 64-bit signed integer identifiers.
- Breaking A change will be made to
OrganizationInvitation.inviter.Description:inviterwill be removed.inviterwill be replaced byinviterActor.Reason:inviterwill be removed.
- Breaking A change will be made to
CreateTeamDiscussionPayload.teamDiscussion.Description:teamDiscussionwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionInput.title.Description:titlewill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionInput.teamId.Description:teamIdwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionInput.private.Description:privatewill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionInput.body.Description:bodywill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionCommentPayload.teamDiscussionComment.Description:teamDiscussionCommentwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionCommentInput.discussionId.Description:discussionIdwill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
- Breaking A change will be made to
CreateTeamDiscussionCommentInput.body.Description:bodywill be removed. Follow the guide at http://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.Reason:The Team Discussions feature is deprecated in favor of Organization Discussions.
Changes scheduled for 2024-04-01
- Breaking A change will be made to
TopicSuggestionDeclineReason.TOO_SPECIFIC.Description:TOO_SPECIFICwill be removed.Reason:Suggested topics are no longer supported
- Breaking A change will be made to
TopicSuggestionDeclineReason.TOO_GENERAL.Description:TOO_GENERALwill be removed.Reason:Suggested topics are no longer supported
- Breaking A change will be made to
TopicSuggestionDeclineReason.PERSONAL_PREFERENCE.Description:PERSONAL_PREFERENCEwill be removed.Reason:Suggested topics are no longer supported
- Breaking A change will be made to
TopicSuggestionDeclineReason.NOT_RELEVANT.Description:NOT_RELEVANTwill be removed.Reason:Suggested topics are no longer supported
Changes scheduled for 2023-10-01
- Breaking A change will be made to
PullRequestReviewComment.position.Description:positionwill be removed. Use thelineandstartLinefields instead, which are file line numbers instead of diff line numbersReason:We are phasing out diff-relative positioning for PR comments
- Breaking A change will be made to
PullRequestReviewComment.originalPosition.Description:originalPositionwill be removed.Reason:We are phasing out diff-relative positioning for PR comments
- Breaking A change will be made to
AddPullRequestReviewInput.comments.Description:commentswill be removed. use thethreadsargument insteadReason:We are deprecating comment fields that use diff-relative positioning
- Breaking A change will be made to
AddPullRequestReviewCommentInput.pullRequestReviewId.Description:pullRequestReviewIdwill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.pullRequestId.Description:pullRequestIdwill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.position.Description:positionwill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.path.Description:pathwill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.inReplyTo.Description:inReplyTowill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.commitOID.Description:commitOIDwill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.body.Description:bodywill be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
Changes scheduled for 2023-07-01
- Breaking A change will be made to
ProjectV2ItemFieldGroup.field.Description:fieldwill be removed. Check out theProjectV2ItemFieldGroup#groupByFieldAPI as an example for the more capable alternative.Reason:The
ProjectV2ItemFieldGroup#fieldAPI is deprecated in favour of the more capableProjectV2ItemFieldGroup#groupByFieldAPI.
- Breaking A change will be made to
Commit.pushedDate.Description:pushedDatewill be removed.Reason:pushedDateis no longer supported.
Changes scheduled for 2023-04-01
- Breaking A change will be made to
Repository.squashPrTitleUsedAsDefault.Description:squashPrTitleUsedAsDefaultwill be removed. UseRepository.squashMergeCommitTitleinstead.Reason:squashPrTitleUsedAsDefaultwill be removed.
- Breaking A change will be made to
ProjectV2View.verticalGroupBy.Description:verticalGroupBywill be removed. Check out theProjectV2View#vertical_group_by_fieldsAPI as an example for the more capable alternative.Reason:The
ProjectV2View#vertical_group_byAPI is deprecated in favour of the more capableProjectV2View#vertical_group_by_fieldsAPI.
- Breaking A change will be made to
ProjectV2View.sortBy.Description:sortBywill be removed. Check out theProjectV2View#sort_by_fieldsAPI as an example for the more capable alternative.Reason:The
ProjectV2View#sort_byAPI is deprecated in favour of the more capableProjectV2View#sort_by_fieldsAPI.
- Breaking A change will be made to
ProjectV2View.groupBy.Description:groupBywill be removed. Check out theProjectV2View#group_by_fieldsAPI as an example for the more capable alternative.Reason:The
ProjectV2View#order_byAPI is deprecated in favour of the more capableProjectV2View#group_by_fieldAPI.
Changes scheduled for 2023-02-10
- Breaking A change will be made to
PackageType.MAVEN.Description:MAVENwill be removed.Reason:MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.
Changes scheduled for 2023-01-01
- Breaking A change will be made to
ProjectV2View.visibleFields.Description:visibleFieldswill be removed. Check out theProjectV2View#fieldsAPI as an example for the more capable alternative.Reason:The
ProjectV2View#visibleFieldsAPI is deprecated in favour of the more capableProjectV2View#fieldsAPI.
- Breaking A change will be made to
Commit.changedFiles.Description:changedFileswill be removed. UsechangedFilesIfAvailableinstead.Reason:changedFileswill be removed.
Changes scheduled for 2022-12-28
- Breaking A change will be made to
PackageType.RUBYGEMS.Description:RUBYGEMSwill be removed.Reason:RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.
Changes scheduled for 2022-11-21
- Breaking A change will be made to
PackageType.NUGET.Description:NUGETwill be removed.Reason:NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.
- Breaking A change will be made to
PackageType.NPM.Description:NPMwill be removed.Reason:NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.
Changes scheduled for 2022-10-01
- Breaking A change will be made to
RemovePullRequestFromMergeQueueInput.branch.Description:branchwill be removed.Reason:PRs are removed from the merge queue for the base branch, the
branchargument is now a no-op
- Breaking A change will be made to
DependencyGraphDependency.packageLabel.Description:packageLabelwill be removed. Use normalizedpackageNamefield instead.Reason:packageLabelwill be removed.
Changes scheduled for 2022-07-01
- Breaking A change will be made to
AddPullRequestToMergeQueueInput.branch.Description:branchwill be removed.Reason:PRs are added to the merge queue for the base branch, the
branchargument is now a no-op
Changes scheduled for 2021-10-01
- Breaking A change will be made to
ReactionGroup.users.Description:userswill be removed. Use thereactorsfield 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:DOCKERwill 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:DRAFTwill be removed. Use PullRequest.isDraft instead.Reason:DRAFT state will be removed from this enum and
isDraftshould be used instead
Changes scheduled for 2020-10-01
- Breaking A change will be made to
PullRequest.timeline.Description:timelinewill be removed. Use PullRequest.timelineItems instead.Reason:timelinewill be removed
- Breaking A change will be made to
Issue.timeline.Description:timelinewill be removed. Use Issue.timelineItems instead.Reason:timelinewill be removed
Changes scheduled for 2020-01-01
- Breaking A change will be made to
UnassignedEvent.user.Description:userwill be removed. Use theassigneefield instead.Reason:Assignees can now be mannequins.
- Breaking A change will be made to
AssignedEvent.user.Description:userwill be removed. Use theassigneefield instead.Reason:Assignees can now be mannequins.
Changes scheduled for 2019-04-01
- Breaking A change will be made to
LegacyMigration.uploadUrlTemplate.Description:uploadUrlTemplatewill be removed. UseuploadUrlinstead.Reason:uploadUrlTemplateis being removed because it is not a standard URL and adds an extra user step.