호환성이 손상되는 변경 정보
호환성이 손상되는 변경이란 통합자의 조치가 필요할 수 있는 모든 변경을 말합니다. 이러한 변경은 다음 두 가지 범주로 구분됩니다.
- 호환성 손상: GraphQL API에 대한 기존 쿼리를 중단하는 변경. 예를 들어 필드를 제거하는 것은 호환성이 손상되는 변경입니다.
- 위험: 기존 쿼리를 중단하지 않지만 클라이언트의 런타임 동작에 영향을 줄 수 있는 변경. 열거형 값을 추가하는 것은 위험한 변경의 예입니다.
당사는 통합업체에 안정적인 API를 제공하기 위해 노력하고 있습니다. 새 기능이 계속 발전 중인 경우 스키마 미리 보기 이후에 릴리스합니다.
통합자에게 필요한 조정을 수행할 시간을 주기 위해, 당사는 GraphQL 스키마를 변경하기 최소 3개월 전에 예정된 호환성이 손상되는 변경을 발표할 예정입니다. 변경은 분기의 첫째 날(1월 1일, 4월 1일, 7월 1일 또는 10월 1일)에 적용됩니다. 예를 들어 1월 15일에 변경 내용을 발표하면 7월 1일에 적용됩니다.
Changes scheduled for 2022-10-01
- Breaking A change will be made to
UnlockAndResetMergeGroupInput.branch
.Description:
branch
will be removed.Reason:
The current merge group for the repository's default branch, the
branch
argument is now a no-op
- Breaking A change will be made to
RepositoryVulnerabilityAlert.fixReason
.Description:
fixReason
will be removed.Reason:
The
fixReason
field is being removed. You can still usefixedAt
anddismissReason
.
- 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
ProjectNextFieldType.TRACKS
.Description:
TRACKS
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.TITLE
.Description:
TITLE
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.TEXT
.Description:
TEXT
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.SINGLE_SELECT
.Description:
SINGLE_SELECT
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.REVIEWERS
.Description:
REVIEWERS
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.REPOSITORY
.Description:
REPOSITORY
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.NUMBER
.Description:
NUMBER
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.MILESTONE
.Description:
MILESTONE
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.LINKED_PULL_REQUESTS
.Description:
LINKED_PULL_REQUESTS
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.LABELS
.Description:
LABELS
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.ITERATION
.Description:
ITERATION
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.DATE
.Description:
DATE
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
ProjectNextFieldType.ASSIGNEES
.Description:
ASSIGNEES
will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.Reason:
The
ProjectNext
API is deprecated in favour of the more capableProjectV2
API.
- Breaking A change will be made to
MergeLockedMergeGroupInput.branch
.Description:
branch
will be removed.Reason:
Changes are merged into the repository's default branch, the
branch
argument is now a no-op
- Breaking A change will be made to
LockMergeQueueInput.branch
.Description:
branch
will be removed.Reason:
The merge queue is locked for the repository's default branch, the
branch
argument is now a no-op
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 2022-04-01
- Breaking A change will be made to
Repository.defaultMergeQueue
.Description:
defaultMergeQueue
will be removed. UseRepository.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 thereactors
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 theassignee
field instead.Reason:
Assignees can now be mannequins.
- Breaking A change will be made to
AssignedEvent.user
.Description:
user
will be removed. Use theassignee
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. UseuploadUrl
instead.Reason:
uploadUrlTemplate
is being removed because it is not a standard URL and adds an extra user step.