Alterações de quebra

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 para os 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-04-01

Breaking A change will be made to Repository.squashPrTitleUsedAsDefault.
Description:
squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.
Reason:
squashPrTitleUsedAsDefault will be removed.

Breaking A change will be made to ProjectV2View.verticalGroupBy.
Description:
verticalGroupBy will be removed. Check out the ProjectV2View#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 capable ProjectV2View#vertical_group_by_fields API.

Breaking A change will be made to ProjectV2View.sortBy.
Description:
sortBy will be removed. Check out the ProjectV2View#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 capable ProjectV2View#sort_by_fields API.

Breaking A change will be made to ProjectV2View.groupBy.
Description:
groupBy will be removed. Check out the ProjectV2View#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 capable ProjectV2View#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 the ProjectV2View#fields API as an example for the more capable alternative.
Reason:
The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

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 capable ProjectV2 API.

Breaking A change will be made to ProjectNextFieldType.TRACKED_BY.
Description:
TRACKED_BY 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 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 capable ProjectV2 API.

Breaking A change will be made to Commit.changedFiles.
Description:
changedFiles will be removed. Use changedFilesIfAvailable instead.
Reason:
changedFiles will be removed.

Changes scheduled for 2022-10-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 use fixedAt and dismissReason.

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

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. Use Repository.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 the reactors 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 the assignee field instead.
Reason:
Assignees can now be mannequins.

Breaking A change will be made to AssignedEvent.user.
Description:
user will be removed. Use the assignee 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. Use uploadUrl instead.
Reason:
uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.