Acerca de los cambios sustanciales
Los cambios sustanciales son aquellos que pudieran necesitar que nuestros integradores realicen alguna acción al respecto. Dividimos estos cambios en dos categorías:
- Importantes: cambios que interrumpirán consultas existentes a GraphQL API. Por ejemplo, eliminar un campo sería un cambio sustancial.
- Peligrosos: cambios que no interrumpirán las consultas existentes, pero que podrían afectar al comportamiento del tiempo de ejecución de los clientes. Agregar un valor de enumerador es un ejemplo de un cambio peligroso.
Nos esforzamos por proporcionar API estables para nuestros integradores. Cuando una característica nueva sigue en evolución, se publica detrás de una versión preliminar del esquema.
Anunciaremos los cambios sustanciales por venir por lo menos tres meses antes de aplicarlos al modelo de GraphQL, para proporcionar a los integradores tiempo para realizar los ajustes necesarios. Los cambios toman efecto en el primer día de un trimestre (1 de enero, 1 de abril, 1 de julio, o 1 de octubre). Por ejemplo, si anunciamos un cambio en el 15 de enero, se aplicará en el 1 de julio.
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.