Changements cassants

À propos des changements cassants

Les changements cassants sont tous les changements qui peuvent nécessiter une action de la part de nos intégrateurs. Nous répartissons ces changements en deux catégories :

Cassants : changements qui interrompent les requêtes existantes à l’API GraphQL. Par exemple, la suppression d’un champ constitue un changement cassant.
Dangereux : changements qui n’interrompent pas les requêtes existantes, mais qui peuvent affecter le comportement d’exécution des clients. L’ajout d’une valeur d’enum est un exemple de changement dangereux.

Nous nous efforçons de fournir des API stables pour nos intégrateurs. Lorsqu’une nouvelle fonctionnalité est toujours en cours d’évolution, nous la publions derrière une préversion de schéma.

Nous annoncerons les changements cassants à venir au moins trois mois avant de modifier le schéma GraphQL, afin de donner aux intégrateurs le temps d’apporter les ajustements nécessaires. Les changements entrent en vigueur le premier jour d’un trimestre (1er janvier, 1er avril, 1er juillet ou 1er octobre). Par exemple, si nous annonçons une modification le 15 janvier, elle sera apportée le 1er juillet.

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 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

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.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 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. 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.