Sobre alterações significativas
Alterações significativas são quaisquer mudanças que possam exigir ação dos nossos integrantes. Dividimos essas alterações em duas categorias:
- Interruptivas: alterações que interromperão as consultas existentes na API do GraphQL. Por exemplo, a eliminação de um campo seria uma mudança decisiva.
- Perigosas: alterações que não interromperão as consultas existentes, mas que poderão afetar o comportamento de runtime dos clientes. Adicionar um valor de enumerador é um exemplo de uma alteração perigosa.
Nós nos esforçamos para fornecer APIs estáveis aos nossos integrantes. Quando um novo recurso ainda está em evolução, nós o lançamos por trás de uma versão prévia de esquema.
Vamos anunciar as próximas mudanças significativas em andamento pelo menos três meses antes de fazer alterações no esquema do GraphQL para dar tempo aos integradores de fazer os ajustes necessários. As alterações entram em vigor no primeiro dia do trimestre (1 de janeiro, 1 de abril, 1 de julho ou 1 de outubro). Por exemplo, se anunciarmos uma mudança no dia 15 de Janeiro, ela entrará em vigor no dia 1 de julho.
Changes scheduled for 2023-10-01
- Breaking A change will be made to
PullRequestReviewComment.position
.Description:position
will be removed. Use theline
andstartLine
fields instead, which are file line numbers instead of diff line numbersReason:We are phasing out diff-relative positioning for PR comments
- Breaking A change will be made to
PullRequestReviewComment.originalPosition
.Description:originalPosition
will be removed.Reason:We are phasing out diff-relative positioning for PR comments
- Breaking A change will be made to
AddPullRequestReviewInput.comments
.Description:comments
will be removed. use thethreads
argument insteadReason:We are deprecating comment fields that use diff-relative positioning
- Breaking A change will be made to
AddPullRequestReviewCommentInput.pullRequestReviewId
.Description:pullRequestReviewId
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.pullRequestId
.Description:pullRequestId
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.position
.Description:position
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.path
.Description:path
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.inReplyTo
.Description:inReplyTo
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.commitOID
.Description:commitOID
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
- Breaking A change will be made to
AddPullRequestReviewCommentInput.body
.Description:body
will be removed. use addPullRequestReviewThread or addPullRequestReviewThreadReply insteadReason:We are deprecating the addPullRequestReviewComment mutation
Changes scheduled for 2023-07-01
- Breaking A change will be made to
ProjectV2ItemFieldGroup.field
.Description:field
will be removed. Check out theProjectV2ItemFieldGroup#groupByField
API as an example for the more capable alternative.Reason:The
ProjectV2ItemFieldGroup#field
API is deprecated in favour of the more capableProjectV2ItemFieldGroup#groupByField
API.
- Breaking A change will be made to
MergeQueueEntry.isSolo
.Description:isSolo
will be removed. Usesolo
instead.Reason:isSolo
will be removed.
- Breaking A change will be made to
MergeQueueEntry.headOid
.Description:headOid
will be removed. UseheadCommit
instead.Reason:headOid
will be removed.
- Breaking A change will be made to
MergeQueueEntry.hasJumpedQueue
.Description:hasJumpedQueue
will be removed. Usejump
instead.Reason:hasJumpedQueue
will be removed.
- Breaking A change will be made to
MergeQueueEntry.checkStatus
.Description:checkStatus
will be removed. Usestate
instead.Reason:checkStatus
will be removed.
- Breaking A change will be made to
MergeQueueEntry.blockedByMergeConflicts
.Description:blockedByMergeConflicts
will be removed. Usestate
instead.Reason:blockedByMergeConflicts
will be removed.
- Breaking A change will be made to
MergeQueueEntry.baseOid
.Description:baseOid
will be removed. UsebaseCommit
instead.Reason:baseOid
will be removed.
- Breaking A change will be made to
MergeQueue.pendingRemovalEntries
.Description:pendingRemovalEntries
will be removed.Reason:pendingRemovalEntries
will be removed.
- Breaking A change will be made to
MergeQueue.mergingEntries
.Description:mergingEntries
will be removed.Reason:mergingEntries
will be removed.
- Breaking A change will be made to
MergeQueue.mergeMethod
.Description:mergeMethod
will be removed. Useconfiguration.merge_method
instead.Reason:mergeMethod
will be removed.
- Breaking A change will be made to
MergeQueue.headOid
.Description:headOid
will be removed. Useentry.headOid
instead.Reason:headOid
will be removed.
- Breaking A change will be made to
Commit.pushedDate
.Description:pushedDate
will be removed.Reason:pushedDate
is no longer supported.
Changes scheduled for 2023-04-01
- 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
Repository.squashPrTitleUsedAsDefault
.Description:squashPrTitleUsedAsDefault
will be removed. UseRepository.squashMergeCommitTitle
instead.Reason:squashPrTitleUsedAsDefault
will be removed.
- Breaking A change will be made to
ProjectV2View.verticalGroupBy
.Description:verticalGroupBy
will be removed. Check out theProjectV2View#vertical_group_by_fields
API as an example for the more capable alternative.Reason:The
ProjectV2View#vertical_group_by
API is deprecated in favour of the more capableProjectV2View#vertical_group_by_fields
API.
- Breaking A change will be made to
ProjectV2View.sortBy
.Description:sortBy
will be removed. Check out theProjectV2View#sort_by_fields
API as an example for the more capable alternative.Reason:The
ProjectV2View#sort_by
API is deprecated in favour of the more capableProjectV2View#sort_by_fields
API.
- Breaking A change will be made to
ProjectV2View.groupBy
.Description:groupBy
will be removed. Check out theProjectV2View#group_by_fields
API as an example for the more capable alternative.Reason:The
ProjectV2View#order_by
API is deprecated in favour of the more capableProjectV2View#group_by_field
API.
Changes scheduled for 2023-01-01
- Breaking A change will be made to
ProjectV2View.visibleFields
.Description:visibleFields
will be removed. Check out theProjectV2View#fields
API as an example for the more capable alternative.Reason:The
ProjectV2View#visibleFields
API is deprecated in favour of the more capableProjectV2View#fields
API.
- Breaking A change will be made to
Commit.changedFiles
.Description:changedFiles
will be removed. UsechangedFilesIfAvailable
instead.Reason:changedFiles
will be removed.
Changes scheduled for 2022-10-01
- 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
DependencyGraphDependency.packageLabel
.Description:packageLabel
will be removed. Use normalizedpackageName
field instead.Reason:packageLabel
will be removed.
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 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.