破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。
- 破壊的: GraphQL API に対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
- 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更。 enum値の追加は危険な変更の例です。
私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマ プレビューの背後でリリースしています。
今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は7月1日に行われます。
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-10-01
- Breaking A change will be made to
UnlockAndResetMergeGroupInput.branch.Description:
branchwill be removed.Reason:
The current merge group for the repository's default branch, the
branchargument is now a no-op
- Breaking A change will be made to
RepositoryVulnerabilityAlert.fixReason.Description:
fixReasonwill be removed.Reason:
The
fixReasonfield is being removed. You can still usefixedAtanddismissReason.
- 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
ProjectNextFieldType.TRACKS.Description:
TRACKSwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.TITLE.Description:
TITLEwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.TEXT.Description:
TEXTwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.SINGLE_SELECT.Description:
SINGLE_SELECTwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.REVIEWERS.Description:
REVIEWERSwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.REPOSITORY.Description:
REPOSITORYwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.NUMBER.Description:
NUMBERwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.MILESTONE.Description:
MILESTONEwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.LINKED_PULL_REQUESTS.Description:
LINKED_PULL_REQUESTSwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.LABELS.Description:
LABELSwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.ITERATION.Description:
ITERATIONwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.DATE.Description:
DATEwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
ProjectNextFieldType.ASSIGNEES.Description:
ASSIGNEESwill 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
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking A change will be made to
MergeLockedMergeGroupInput.branch.Description:
branchwill be removed.Reason:
Changes are merged into the repository's default branch, the
branchargument is now a no-op
- Breaking A change will be made to
LockMergeQueueInput.branch.Description:
branchwill be removed.Reason:
The merge queue is locked for the repository's default branch, the
branchargument is now a no-op
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 2022-04-01
- Breaking A change will be made to
Repository.defaultMergeQueue.Description:
defaultMergeQueuewill be removed. UseRepository.mergeQueueinstead.Reason:
defaultMergeQueuewill be removed.
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.