破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。
- 破壊的: GraphQL APIに対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
- 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更です。 enum値の追加は危険な変更の例です。
私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマプレビューの背後でリリースしています。
今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は7月1日に行われます。
2022-10-01にスケジュールされた変更
- 破壊的変更が
UpdateProjectNextItemFieldInput.fieldWithSettingIdに対して行われます。説明:
fieldWithSettingIdwill be removed. UsefieldConstraintIdinstead理由:
Renamed to fieldConstraintId to improve naming consistency.
2022-07-01にスケジュールされた変更
- 破壊的変更が
Query.sponsorables.dependencyEcosystemに対して行われます。説明:
dependencyEcosystemwill be removed. Use the ecosystem argument instead.理由:
The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.
- 破壊的変更が
Enterprise.userAccountsに対して行われます。説明:
userAccountswill be removed. Use theEnterprise.membersfield instead.理由:
The
Enterprise.userAccountsfield is being removed.
- 破壊的変更が
AddPullRequestToMergeQueueInput.branchに対して行われます。説明:
branchwill be removed.理由:
PRs are added to the merge queue for the base branch, the
branchargument is now a no-op
2022-04-01にスケジュールされた変更
- 破壊的変更が
Repository.defaultMergeQueueに対して行われます。説明:
defaultMergeQueuewill be removed. UseRepository.mergeQueueinstead.理由:
defaultMergeQueuewill be removed.
2021-10-01にスケジュールされた変更
- 破壊的変更が
ReactionGroup.usersに対して行われます。説明:
userswill be removed. Use thereactorsfield instead.理由:
Reactors can now be mannequins, bots, and organizations.
2021-06-21にスケジュールされた変更
- 破壊的変更が
PackageType.DOCKERに対して行われます。説明:
DOCKERwill be removed.理由:
DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.
2021-01-01にスケジュールされた変更
- 破壊的変更が
MergeStateStatus.DRAFTに対して行われます。説明:
DRAFTwill be removed. Use PullRequest.isDraft instead.理由:
DRAFT state will be removed from this enum and
isDraftshould be used instead
2020-10-01にスケジュールされた変更
- 破壊的変更が
Sponsorship.sponsorに対して行われます。説明:
sponsorwill be removed. UseSponsorship.sponsorEntityinstead.理由:
Sponsorship.sponsorwill be removed.
- 破壊的変更が
PullRequest.timelineに対して行われます。説明:
timelinewill be removed. Use PullRequest.timelineItems instead.理由:
timelinewill be removed
- 破壊的変更が
Issue.timelineに対して行われます。説明:
timelinewill be removed. Use Issue.timelineItems instead.理由:
timelinewill be removed
2020-04-01にスケジュールされた変更
- 破壊的変更が
Sponsorship.maintainerに対して行われます。説明:
maintainerwill be removed. UseSponsorship.sponsorableinstead.理由:
Sponsorship.maintainerwill be removed.
2020-01-01にスケジュールされた変更
- 破壊的変更が
UnassignedEvent.userに対して行われます。説明:
userwill be removed. Use theassigneefield instead.理由:
Assignees can now be mannequins.
- 破壊的変更が
AssignedEvent.userに対して行われます。説明:
userwill be removed. Use theassigneefield instead.理由:
Assignees can now be mannequins.
2019-04-01にスケジュールされた変更
- 破壊的変更が
LegacyMigration.uploadUrlTemplateに対して行われます。説明:
uploadUrlTemplatewill be removed. UseuploadUrlinstead.理由:
uploadUrlTemplateis being removed because it is not a standard URL and adds an extra user step.