关于重大变更
重大变更是指可能需要集成商采取行动的任何变更。 我们将这些变更分为两类:
- 重大:会改变 GraphQL API 的现有查询的变更。 例如,删除字段就是重大变更。
- 危险:不会改变现有查询,但会影响客户端运行时的行为的变更。 添加枚举值就是一个危险变更示例。
我们努力为集成商提供稳定的 API。 当某项新功能还处于演进阶段时,我们将在架构预览模式下发布此功能。
我们将在更改 GraphQL 架构前至少三个月宣布即将发生的重大变更,以便给集成商预留进行必要调整的时间。 变更在季度第一天(1 月 1 日、4 月 1 日、7 月 1 日或 10 月 1 日)生效。 例如,如果我们在 1 月 15 日宣布变更,将在 7 月 1 日执行。
安排在 2022-10-01 进行变更
- Breaking 将对
UpdateProjectNextItemFieldInput.fieldWithSettingId
进行变更。.描述:
fieldWithSettingId
will be removed. UsefieldConstraintId
instead原因:
Renamed to fieldConstraintId to improve naming consistency.
安排在 2022-07-01 进行变更
- Breaking 将对
Query.sponsorables.dependencyEcosystem
进行变更。.描述:
dependencyEcosystem
will be removed. Use the ecosystem argument instead.原因:
The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.
- Breaking 将对
Enterprise.userAccounts
进行变更。.描述:
userAccounts
will be removed. Use theEnterprise.members
field instead.原因:
The
Enterprise.userAccounts
field is being removed.
- Breaking 将对
AddPullRequestToMergeQueueInput.branch
进行变更。.描述:
branch
will be removed.原因:
PRs are added to the merge queue for the base branch, the
branch
argument is now a no-op
安排在 2022-04-01 进行变更
- Breaking 将对
Repository.defaultMergeQueue
进行变更。.描述:
defaultMergeQueue
will be removed. UseRepository.mergeQueue
instead.原因:
defaultMergeQueue
will be removed.
安排在 2021-10-01 进行变更
- Breaking 将对
ReactionGroup.users
进行变更。.描述:
users
will be removed. Use thereactors
field instead.原因:
Reactors can now be mannequins, bots, and organizations.
安排在 2021-06-21 进行变更
- Breaking 将对
PackageType.DOCKER
进行变更。.描述:
DOCKER
will 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
进行变更。.描述:
DRAFT
will be removed. Use PullRequest.isDraft instead.原因:
DRAFT state will be removed from this enum and
isDraft
should be used instead
安排在 2020-10-01 进行变更
- Breaking 将对
Sponsorship.sponsor
进行变更。.描述:
sponsor
will be removed. UseSponsorship.sponsorEntity
instead.原因:
Sponsorship.sponsor
will be removed.
- Breaking 将对
PullRequest.timeline
进行变更。.描述:
timeline
will be removed. Use PullRequest.timelineItems instead.原因:
timeline
will be removed
- Breaking 将对
Issue.timeline
进行变更。.描述:
timeline
will be removed. Use Issue.timelineItems instead.原因:
timeline
will be removed
安排在 2020-04-01 进行变更
- Breaking 将对
Sponsorship.maintainer
进行变更。.描述:
maintainer
will be removed. UseSponsorship.sponsorable
instead.原因:
Sponsorship.maintainer
will be removed.
安排在 2020-01-01 进行变更
- Breaking 将对
UnassignedEvent.user
进行变更。.描述:
user
will be removed. Use theassignee
field instead.原因:
Assignees can now be mannequins.
- Breaking 将对
AssignedEvent.user
进行变更。.描述:
user
will be removed. Use theassignee
field instead.原因:
Assignees can now be mannequins.
安排在 2019-04-01 进行变更
- Breaking 将对
LegacyMigration.uploadUrlTemplate
进行变更。.描述:
uploadUrlTemplate
will be removed. UseuploadUrl
instead.原因:
uploadUrlTemplate
is being removed because it is not a standard URL and adds an extra user step.