이 버전의 GitHub Enterprise는 다음 날짜에 중단되었습니다. 2024-07-09. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 더 뛰어난 성능, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise Server로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

호환성이 손상되는 변경

GitHub GraphQL API에 대한 최근 및 향후 호환성이 손상되는 변경에 대해 알아봅니다.

이 문서의 내용

호환성이 손상되는 변경 정보

호환성이 손상되는 변경이란 통합자의 조치가 필요할 수 있는 모든 변경을 말합니다. 이러한 변경은 다음 두 가지 범주로 구분됩니다.

  • 호환성 손상: GraphQL API에 대한 기존 쿼리를 중단하는 변경. 예를 들어 필드를 제거하는 것은 호환성이 손상되는 변경입니다.
  • 위험: 기존 쿼리를 중단하지 않지만 클라이언트의 런타임 동작에 영향을 줄 수 있는 변경. 열거형 값을 추가하는 것은 위험한 변경의 예입니다.

당사는 통합업체에 안정적인 API를 제공하기 위해 노력하고 있습니다. 새 기능이 계속 발전 중인 경우 스키마 미리 보기 이후에 릴리스합니다.

통합자에게 필요한 조정을 수행할 시간을 주기 위해, 당사는 GraphQL 스키마를 변경하기 최소 3개월 전에 예정된 호환성이 손상되는 변경을 발표할 예정입니다. 변경은 분기의 첫째 날(1월 1일, 4월 1일, 7월 1일 또는 10월 1일)에 적용됩니다. 예를 들어 1월 15일에 변경 내용을 발표하면 7월 1일에 적용됩니다.

Changes scheduled for 2023-10-01

  • Breaking A change will be made to PullRequestReviewComment.position.
    Description:

    position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

    Reason:

    We are phasing out diff-relative positioning for PR comments

  • Breaking A change will be made to PullRequestReviewComment.originalPosition.
    Description:

    originalPosition will be removed.

    Reason:

    We are phasing out diff-relative positioning for PR comments

  • Breaking A change will be made to AddPullRequestReviewInput.comments.
    Description:

    comments will be removed. use the threads argument instead

    Reason:

    We are deprecating comment fields that use diff-relative positioning

  • Breaking A change will be made to AddPullRequestReviewCommentInput.pullRequestReviewId.
    Description:

    pullRequestReviewId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.pullRequestId.
    Description:

    pullRequestId will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.position.
    Description:

    position will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.path.
    Description:

    path will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.inReplyTo.
    Description:

    inReplyTo will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.commitOID.
    Description:

    commitOID will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

  • Breaking A change will be made to AddPullRequestReviewCommentInput.body.
    Description:

    body will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply instead

    Reason:

    We are deprecating the addPullRequestReviewComment mutation

Changes scheduled for 2023-07-01

  • Breaking A change will be made to ProjectV2ItemFieldGroup.field.
    Description:

    field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

    Reason:

    The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

  • Breaking A change will be made to MergeQueueEntry.isSolo.
    Description:

    isSolo will be removed. Use solo instead.

    Reason:

    isSolo will be removed.

  • Breaking A change will be made to MergeQueueEntry.headOid.
    Description:

    headOid will be removed. Use headCommit instead.

    Reason:

    headOid will be removed.

  • Breaking A change will be made to MergeQueueEntry.hasJumpedQueue.
    Description:

    hasJumpedQueue will be removed. Use jump instead.

    Reason:

    hasJumpedQueue will be removed.

  • Breaking A change will be made to MergeQueueEntry.checkStatus.
    Description:

    checkStatus will be removed. Use state instead.

    Reason:

    checkStatus will be removed.

  • Breaking A change will be made to MergeQueueEntry.blockedByMergeConflicts.
    Description:

    blockedByMergeConflicts will be removed. Use state instead.

    Reason:

    blockedByMergeConflicts will be removed.

  • Breaking A change will be made to MergeQueueEntry.baseOid.
    Description:

    baseOid will be removed. Use baseCommit instead.

    Reason:

    baseOid will be removed.

  • Breaking A change will be made to MergeQueue.pendingRemovalEntries.
    Description:

    pendingRemovalEntries will be removed.

    Reason:

    pendingRemovalEntries will be removed.

  • Breaking A change will be made to MergeQueue.mergingEntries.
    Description:

    mergingEntries will be removed.

    Reason:

    mergingEntries will be removed.

  • Breaking A change will be made to MergeQueue.mergeMethod.
    Description:

    mergeMethod will be removed. Use configuration.merge_method instead.

    Reason:

    mergeMethod will be removed.

  • Breaking A change will be made to MergeQueue.headOid.
    Description:

    headOid will be removed. Use entry.headOid instead.

    Reason:

    headOid will be removed.

  • Breaking A change will be made to Commit.pushedDate.
    Description:

    pushedDate will be removed.

    Reason:

    pushedDate is no longer supported.

Changes scheduled for 2023-04-01

  • Breaking A change will be made to RepositoryVulnerabilityAlert.fixReason.
    Description:

    fixReason will be removed.

    Reason:

    The fixReason field is being removed. You can still use fixedAt and dismissReason.

  • Breaking A change will be made to Repository.squashPrTitleUsedAsDefault.
    Description:

    squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

    Reason:

    squashPrTitleUsedAsDefault will be removed.

  • Breaking A change will be made to ProjectV2View.verticalGroupBy.
    Description:

    verticalGroupBy will be removed. Check out the ProjectV2View#vertical_group_by_fields API as an example for the more capable alternative.

    Reason:

    The ProjectV2View#vertical_group_by API is deprecated in favour of the more capable ProjectV2View#vertical_group_by_fields API.

  • Breaking A change will be made to ProjectV2View.sortBy.
    Description:

    sortBy will be removed. Check out the ProjectV2View#sort_by_fields API as an example for the more capable alternative.

    Reason:

    The ProjectV2View#sort_by API is deprecated in favour of the more capable ProjectV2View#sort_by_fields API.

  • Breaking A change will be made to ProjectV2View.groupBy.
    Description:

    groupBy will be removed. Check out the ProjectV2View#group_by_fields API as an example for the more capable alternative.

    Reason:

    The ProjectV2View#order_by API is deprecated in favour of the more capable ProjectV2View#group_by_field API.

Changes scheduled for 2023-01-01

  • Breaking A change will be made to ProjectV2View.visibleFields.
    Description:

    visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

    Reason:

    The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

  • Breaking A change will be made to Commit.changedFiles.
    Description:

    changedFiles will be removed. Use changedFilesIfAvailable instead.

    Reason:

    changedFiles will be removed.

Changes scheduled for 2022-10-01

  • Breaking A change will be made to RemovePullRequestFromMergeQueueInput.branch.
    Description:

    branch will be removed.

    Reason:

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

  • Breaking A change will be made to DependencyGraphDependency.packageLabel.
    Description:

    packageLabel will be removed. Use normalized packageName field instead.

    Reason:

    packageLabel will be removed.

Changes scheduled for 2022-07-01

  • 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 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

Changes scheduled for 2020-10-01

  • 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-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 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.