关于重大变更
重大变更是指可能需要集成商采取行动的任何变更。 我们将这些变更分为两类:
- 重大:会改变 GraphQL API 的现有查询的变更。 例如,删除字段就是重大变更。
- 危险:不会改变现有查询,但会影响客户端运行时的行为的变更。 添加枚举值就是一个危险变更示例。
我们努力为集成商提供稳定的 API。 当某项新功能还处于演进阶段时,我们将在架构预览模式下发布此功能。
我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更,以便给集成商预留进行必要调整的时间。 变更在季度第一天(1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日)生效。 例如,如果我们在 1 月 15 日宣布变更,将在 7 月 1 日执行。
安排在 2022-10-01 进行变更
- Breaking 将对
UnlockAndResetMergeGroupInput.branch进行变更。.描述:
branchwill be removed.原因:
The current merge group for the repository's default branch, the
branchargument is now a no-op
- Breaking 将对
RepositoryVulnerabilityAlert.fixReason进行变更。.描述:
fixReasonwill be removed.原因:
The
fixReasonfield is being removed. You can still usefixedAtanddismissReason.
- Breaking 将对
RemovePullRequestFromMergeQueueInput.branch进行变更。.描述:
branchwill be removed.原因:
PRs are removed from the merge queue for the base branch, the
branchargument is now a no-op
- Breaking 将对
ProjectNextFieldType.TRACKS进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.TITLE进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.TEXT进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.SINGLE_SELECT进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.REVIEWERS进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.REPOSITORY进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.NUMBER进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.MILESTONE进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.LINKED_PULL_REQUESTS进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.LABELS进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.ITERATION进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.DATE进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
ProjectNextFieldType.ASSIGNEES进行变更。.描述:
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.原因:
The
ProjectNextAPI is deprecated in favour of the more capableProjectV2API.
- Breaking 将对
MergeLockedMergeGroupInput.branch进行变更。.描述:
branchwill be removed.原因:
Changes are merged into the repository's default branch, the
branchargument is now a no-op
- Breaking 将对
LockMergeQueueInput.branch进行变更。.描述:
branchwill be removed.原因:
The merge queue is locked for the repository's default branch, the
branchargument is now a no-op
安排在 2022-07-01 进行变更
- Breaking 将对
Enterprise.userAccounts进行变更。.描述:
userAccountswill be removed. Use theEnterprise.membersfield instead.原因:
The
Enterprise.userAccountsfield is being removed.
- Breaking 将对
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 进行变更
- Breaking 将对
Repository.defaultMergeQueue进行变更。.描述:
defaultMergeQueuewill be removed. UseRepository.mergeQueueinstead.原因:
defaultMergeQueuewill be removed.
安排在 2021-10-01 进行变更
- Breaking 将对
ReactionGroup.users进行变更。.描述:
userswill be removed. Use thereactorsfield instead.原因:
Reactors can now be mannequins, bots, and organizations.
安排在 2021-06-21 进行变更
- Breaking 将对
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 进行变更
- Breaking 将对
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 进行变更
- Breaking 将对
PullRequest.timeline进行变更。.描述:
timelinewill be removed. Use PullRequest.timelineItems instead.原因:
timelinewill be removed
- Breaking 将对
Issue.timeline进行变更。.描述:
timelinewill be removed. Use Issue.timelineItems instead.原因:
timelinewill be removed
安排在 2020-01-01 进行变更
- Breaking 将对
UnassignedEvent.user进行变更。.描述:
userwill be removed. Use theassigneefield instead.原因:
Assignees can now be mannequins.
- Breaking 将对
AssignedEvent.user进行变更。.描述:
userwill be removed. Use theassigneefield instead.原因:
Assignees can now be mannequins.
安排在 2019-04-01 进行变更
- Breaking 将对
LegacyMigration.uploadUrlTemplate进行变更。.描述:
uploadUrlTemplatewill be removed. UseuploadUrlinstead.原因:
uploadUrlTemplateis being removed because it is not a standard URL and adds an extra user step.