破壊的変更について
破壊的変更は、インテグレーターからのアクションが必要になるかもしれない変更です。 これらの変更は、2つに分類されます。
- 破壊的: GraphQL API に対する既存のクエリを損なう変更。 たとえば、フィールドの削除は破壊的変更です。
- 危険: 既存のクエリを損なうことはないものの、クライアントの実行時の振る舞いに影響するかもしれない変更。 enum値の追加は危険な変更の例です。
私たちは、インテグレーターに安定したAPIを提供するよう努めています。 新しい機能が進化を続けている場合、それはスキーマ プレビューの背後でリリースしています。
今後の破壊的変更のアナウンスは、遅くてもGraphQLスキーマに対して変更を行う3ヶ月前にアナウンスを行い、インテグレーターに必要な調整を行う時間を提供します。 変更は、四半期の初日(1月1日、4月1日、7月1日、10月1日)に適用されます。 たとえば、変更を1月115日にアナウンスした場合、その変更は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.