1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Pipelines version data dir graphql (#34772)

This commit is contained in:
Rachael Sewell
2023-02-15 11:33:40 -08:00
committed by GitHub
parent 6b4d76e09c
commit 790d6a94a8
33 changed files with 3023 additions and 3027 deletions

View File

@@ -5,9 +5,6 @@ redirect_from:
- /v4/changelog
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghae: '*'
topics:
- API
autogenerated: true

View File

@@ -33,7 +33,8 @@ export default function GraphqlChangelog({ mainContext, schema, automatedPageCon
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const req = context.req as any
const res = context.res as any
const schema = getGraphqlChangelog() as ChangelogItemT[]
const currentVersion = context.query.versionId as string
const schema = getGraphqlChangelog(currentVersion) as ChangelogItemT[]
if (!schema) throw new Error('No graphql free-pro-team changelog schema found.')
// Gets the miniTocItems in the article context. At this point it will only
// include miniTocItems that exist in Markdown pages in

View File

@@ -0,0 +1,149 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Access to a repository s dependency graph preview",
"description": "This preview adds support for reading a dependency graph for a repository.",
"toggled_by": "hawkgirl-preview",
"toggled_on": [
"DependencyGraphManifest",
"Repository.dependencyGraphManifests",
"DependencyGraphManifestEdge",
"DependencyGraphManifestConnection",
"DependencyGraphDependency",
"DependencyGraphDependencyEdge",
"DependencyGraphDependencyConnection",
"DependencyGraphPackageRelease.dependencies"
],
"owning_teams": [
"@github/dependency-graph"
],
"accept_header": "application/vnd.github.hawkgirl-preview+json",
"href": "/graphql/overview/schema-previews#access-to-a-repository-s-dependency-graph-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,320 @@
{
"2023-07-01": [
{
"location": "ProjectV2ItemFieldGroup.field",
"description": "<p><code>field</code> will be removed. Check out the <code>ProjectV2ItemFieldGroup#groupByField</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2ItemFieldGroup#field</code> API is deprecated in favour of the more capable <code>ProjectV2ItemFieldGroup#groupByField</code> API.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "stevepopovich"
},
{
"location": "MergeQueueEntry.isSolo",
"description": "<p><code>isSolo</code> will be removed. Use <code>solo</code> instead.</p>",
"reason": "<p><code>isSolo</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>headCommit</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.hasJumpedQueue",
"description": "<p><code>hasJumpedQueue</code> will be removed. Use <code>jump</code> instead.</p>",
"reason": "<p><code>hasJumpedQueue</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.checkStatus",
"description": "<p><code>checkStatus</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>checkStatus</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.blockedByMergeConflicts",
"description": "<p><code>blockedByMergeConflicts</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>blockedByMergeConflicts</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.baseOid",
"description": "<p><code>baseOid</code> will be removed. Use <code>baseCommit</code> instead.</p>",
"reason": "<p><code>baseOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.pendingRemovalEntries",
"description": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"reason": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergingEntries",
"description": "<p><code>mergingEntries</code> will be removed.</p>",
"reason": "<p><code>mergingEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergeMethod",
"description": "<p><code>mergeMethod</code> will be removed. Use <code>configuration.merge_method</code> instead.</p>",
"reason": "<p><code>mergeMethod</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>entry.headOid</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
}
],
"2023-04-01": [
{
"location": "RepositoryVulnerabilityAlert.fixReason",
"description": "<p><code>fixReason</code> will be removed.</p>",
"reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "jamestran201"
},
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
"reason": "<p><code>squashPrTitleUsedAsDefault</code> will be removed.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "github/pull_requests"
},
{
"location": "ProjectV2View.verticalGroupBy",
"description": "<p><code>verticalGroupBy</code> will be removed. Check out the <code>ProjectV2View#vertical_group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#vertical_group_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#vertical_group_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.sortBy",
"description": "<p><code>sortBy</code> will be removed. Check out the <code>ProjectV2View#sort_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#sort_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#sort_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.groupBy",
"description": "<p><code>groupBy</code> will be removed. Check out the <code>ProjectV2View#group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#order_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#group_by_field</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "alcere"
}
],
"2023-02-10": [
{
"location": "PackageType.MAVEN",
"description": "<p><code>MAVEN</code> will be removed.</p>",
"reason": "<p>MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2023-02-10",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
"description": "<p><code>visibleFields</code> will be removed. Check out the <code>ProjectV2View#fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#visibleFields</code> API is deprecated in favour of the more capable <code>ProjectV2View#fields</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "mattruggio"
},
{
"location": "Commit.changedFiles",
"description": "<p><code>changedFiles</code> will be removed. Use <code>changedFilesIfAvailable</code> instead.</p>",
"reason": "<p><code>changedFiles</code> will be removed.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "adamshwert"
}
],
"2022-12-28": [
{
"location": "PackageType.RUBYGEMS",
"description": "<p><code>RUBYGEMS</code> will be removed.</p>",
"reason": "<p>RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-12-28",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2022-11-21": [
{
"location": "PackageType.NUGET",
"description": "<p><code>NUGET</code> will be removed.</p>",
"reason": "<p>NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
},
{
"location": "PackageType.NPM",
"description": "<p><code>NPM</code> will be removed.</p>",
"reason": "<p>NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
}
],
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "DependencyGraphDependency.packageLabel",
"description": "<p><code>packageLabel</code> will be removed. Use normalized <code>packageName</code> field instead.</p>",
"reason": "<p><code>packageLabel</code> will be removed.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "github/dependency_graph"
}
],
"2022-07-01": [
{
"location": "Query.sponsorables.dependencyEcosystem",
"description": "<p><code>dependencyEcosystem</code> will be removed. Use the ecosystem argument instead.</p>",
"reason": "<p>The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "cheshire137"
},
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "Sponsorship.sponsor",
"description": "<p><code>sponsor</code> will be removed. Use <code>Sponsorship.sponsorEntity</code> instead.</p>",
"reason": "<p><code>Sponsorship.sponsor</code> will be removed.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-04-01": [
{
"location": "Sponsorship.maintainer",
"description": "<p><code>maintainer</code> will be removed. Use <code>Sponsorship.sponsorable</code> instead.</p>",
"reason": "<p><code>Sponsorship.maintainer</code> will be removed.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "antn"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,149 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Access to a repository s dependency graph preview",
"description": "This preview adds support for reading a dependency graph for a repository.",
"toggled_by": "hawkgirl-preview",
"toggled_on": [
"DependencyGraphManifest",
"Repository.dependencyGraphManifests",
"DependencyGraphManifestEdge",
"DependencyGraphManifestConnection",
"DependencyGraphDependency",
"DependencyGraphDependencyEdge",
"DependencyGraphDependencyConnection",
"DependencyGraphPackageRelease.dependencies"
],
"owning_teams": [
"@github/dependency-graph"
],
"accept_header": "application/vnd.github.hawkgirl-preview+json",
"href": "/graphql/overview/schema-previews#access-to-a-repository-s-dependency-graph-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,294 @@
{
"2023-07-01": [
{
"location": "ProjectV2ItemFieldGroup.field",
"description": "<p><code>field</code> will be removed. Check out the <code>ProjectV2ItemFieldGroup#groupByField</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2ItemFieldGroup#field</code> API is deprecated in favour of the more capable <code>ProjectV2ItemFieldGroup#groupByField</code> API.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "stevepopovich"
},
{
"location": "MergeQueueEntry.isSolo",
"description": "<p><code>isSolo</code> will be removed. Use <code>solo</code> instead.</p>",
"reason": "<p><code>isSolo</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>headCommit</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.hasJumpedQueue",
"description": "<p><code>hasJumpedQueue</code> will be removed. Use <code>jump</code> instead.</p>",
"reason": "<p><code>hasJumpedQueue</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.checkStatus",
"description": "<p><code>checkStatus</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>checkStatus</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.blockedByMergeConflicts",
"description": "<p><code>blockedByMergeConflicts</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>blockedByMergeConflicts</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.baseOid",
"description": "<p><code>baseOid</code> will be removed. Use <code>baseCommit</code> instead.</p>",
"reason": "<p><code>baseOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.pendingRemovalEntries",
"description": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"reason": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergingEntries",
"description": "<p><code>mergingEntries</code> will be removed.</p>",
"reason": "<p><code>mergingEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergeMethod",
"description": "<p><code>mergeMethod</code> will be removed. Use <code>configuration.merge_method</code> instead.</p>",
"reason": "<p><code>mergeMethod</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>entry.headOid</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
}
],
"2023-04-01": [
{
"location": "RepositoryVulnerabilityAlert.fixReason",
"description": "<p><code>fixReason</code> will be removed.</p>",
"reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "jamestran201"
},
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
"reason": "<p><code>squashPrTitleUsedAsDefault</code> will be removed.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "github/pull_requests"
},
{
"location": "ProjectV2View.verticalGroupBy",
"description": "<p><code>verticalGroupBy</code> will be removed. Check out the <code>ProjectV2View#vertical_group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#vertical_group_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#vertical_group_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.sortBy",
"description": "<p><code>sortBy</code> will be removed. Check out the <code>ProjectV2View#sort_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#sort_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#sort_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.groupBy",
"description": "<p><code>groupBy</code> will be removed. Check out the <code>ProjectV2View#group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#order_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#group_by_field</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "alcere"
}
],
"2023-02-10": [
{
"location": "PackageType.MAVEN",
"description": "<p><code>MAVEN</code> will be removed.</p>",
"reason": "<p>MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2023-02-10",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
"description": "<p><code>visibleFields</code> will be removed. Check out the <code>ProjectV2View#fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#visibleFields</code> API is deprecated in favour of the more capable <code>ProjectV2View#fields</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "mattruggio"
},
{
"location": "Commit.changedFiles",
"description": "<p><code>changedFiles</code> will be removed. Use <code>changedFilesIfAvailable</code> instead.</p>",
"reason": "<p><code>changedFiles</code> will be removed.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "adamshwert"
}
],
"2022-12-28": [
{
"location": "PackageType.RUBYGEMS",
"description": "<p><code>RUBYGEMS</code> will be removed.</p>",
"reason": "<p>RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-12-28",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2022-11-21": [
{
"location": "PackageType.NUGET",
"description": "<p><code>NUGET</code> will be removed.</p>",
"reason": "<p>NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
},
{
"location": "PackageType.NPM",
"description": "<p><code>NPM</code> will be removed.</p>",
"reason": "<p>NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
}
],
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "DependencyGraphDependency.packageLabel",
"description": "<p><code>packageLabel</code> will be removed. Use normalized <code>packageName</code> field instead.</p>",
"reason": "<p><code>packageLabel</code> will be removed.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "github/dependency_graph"
}
],
"2022-07-01": [
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,149 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Access to a repository s dependency graph preview",
"description": "This preview adds support for reading a dependency graph for a repository.",
"toggled_by": "hawkgirl-preview",
"toggled_on": [
"DependencyGraphManifest",
"Repository.dependencyGraphManifests",
"DependencyGraphManifestEdge",
"DependencyGraphManifestConnection",
"DependencyGraphDependency",
"DependencyGraphDependencyEdge",
"DependencyGraphDependencyConnection",
"DependencyGraphPackageRelease.dependencies"
],
"owning_teams": [
"@github/dependency-graph"
],
"accept_header": "application/vnd.github.hawkgirl-preview+json",
"href": "/graphql/overview/schema-previews#access-to-a-repository-s-dependency-graph-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,320 @@
{
"2023-07-01": [
{
"location": "ProjectV2ItemFieldGroup.field",
"description": "<p><code>field</code> will be removed. Check out the <code>ProjectV2ItemFieldGroup#groupByField</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2ItemFieldGroup#field</code> API is deprecated in favour of the more capable <code>ProjectV2ItemFieldGroup#groupByField</code> API.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "stevepopovich"
},
{
"location": "MergeQueueEntry.isSolo",
"description": "<p><code>isSolo</code> will be removed. Use <code>solo</code> instead.</p>",
"reason": "<p><code>isSolo</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>headCommit</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.hasJumpedQueue",
"description": "<p><code>hasJumpedQueue</code> will be removed. Use <code>jump</code> instead.</p>",
"reason": "<p><code>hasJumpedQueue</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.checkStatus",
"description": "<p><code>checkStatus</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>checkStatus</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.blockedByMergeConflicts",
"description": "<p><code>blockedByMergeConflicts</code> will be removed. Use <code>state</code> instead.</p>",
"reason": "<p><code>blockedByMergeConflicts</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueueEntry.baseOid",
"description": "<p><code>baseOid</code> will be removed. Use <code>baseCommit</code> instead.</p>",
"reason": "<p><code>baseOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.pendingRemovalEntries",
"description": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"reason": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergingEntries",
"description": "<p><code>mergingEntries</code> will be removed.</p>",
"reason": "<p><code>mergingEntries</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.mergeMethod",
"description": "<p><code>mergeMethod</code> will be removed. Use <code>configuration.merge_method</code> instead.</p>",
"reason": "<p><code>mergeMethod</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
},
{
"location": "MergeQueue.headOid",
"description": "<p><code>headOid</code> will be removed. Use <code>entry.headOid</code> instead.</p>",
"reason": "<p><code>headOid</code> will be removed.</p>",
"date": "2023-07-01",
"criticality": "breaking",
"owner": "github/merge_queue"
}
],
"2023-04-01": [
{
"location": "RepositoryVulnerabilityAlert.fixReason",
"description": "<p><code>fixReason</code> will be removed.</p>",
"reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "jamestran201"
},
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
"reason": "<p><code>squashPrTitleUsedAsDefault</code> will be removed.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "github/pull_requests"
},
{
"location": "ProjectV2View.verticalGroupBy",
"description": "<p><code>verticalGroupBy</code> will be removed. Check out the <code>ProjectV2View#vertical_group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#vertical_group_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#vertical_group_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.sortBy",
"description": "<p><code>sortBy</code> will be removed. Check out the <code>ProjectV2View#sort_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#sort_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#sort_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.groupBy",
"description": "<p><code>groupBy</code> will be removed. Check out the <code>ProjectV2View#group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#order_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#group_by_field</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "alcere"
}
],
"2023-02-10": [
{
"location": "PackageType.MAVEN",
"description": "<p><code>MAVEN</code> will be removed.</p>",
"reason": "<p>MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2023-02-10",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
"description": "<p><code>visibleFields</code> will be removed. Check out the <code>ProjectV2View#fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#visibleFields</code> API is deprecated in favour of the more capable <code>ProjectV2View#fields</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "mattruggio"
},
{
"location": "Commit.changedFiles",
"description": "<p><code>changedFiles</code> will be removed. Use <code>changedFilesIfAvailable</code> instead.</p>",
"reason": "<p><code>changedFiles</code> will be removed.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "adamshwert"
}
],
"2022-12-28": [
{
"location": "PackageType.RUBYGEMS",
"description": "<p><code>RUBYGEMS</code> will be removed.</p>",
"reason": "<p>RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-12-28",
"criticality": "breaking",
"owner": "ankitkaushal01"
}
],
"2022-11-21": [
{
"location": "PackageType.NUGET",
"description": "<p><code>NUGET</code> will be removed.</p>",
"reason": "<p>NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
},
{
"location": "PackageType.NPM",
"description": "<p><code>NPM</code> will be removed.</p>",
"reason": "<p>NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2022-11-21",
"criticality": "breaking",
"owner": "s-anupam"
}
],
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "DependencyGraphDependency.packageLabel",
"description": "<p><code>packageLabel</code> will be removed. Use normalized <code>packageName</code> field instead.</p>",
"reason": "<p><code>packageLabel</code> will be removed.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "github/dependency_graph"
}
],
"2022-07-01": [
{
"location": "Query.sponsorables.dependencyEcosystem",
"description": "<p><code>dependencyEcosystem</code> will be removed. Use the ecosystem argument instead.</p>",
"reason": "<p>The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "cheshire137"
},
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "Sponsorship.sponsor",
"description": "<p><code>sponsor</code> will be removed. Use <code>Sponsorship.sponsorEntity</code> instead.</p>",
"reason": "<p><code>Sponsorship.sponsor</code> will be removed.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "nholden"
},
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-04-01": [
{
"location": "Sponsorship.maintainer",
"description": "<p><code>maintainer</code> will be removed. Use <code>Sponsorship.sponsorable</code> instead.</p>",
"reason": "<p><code>Sponsorship.maintainer</code> will be removed.</p>",
"date": "2020-04-01",
"criticality": "breaking",
"owner": "antn"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,129 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,144 @@
{
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
},
{
"location": "EnterprisePendingCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All outside collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseMemberEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All members consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-10-01": [
{
"location": "RepositoryInvitationOrderField.INVITEE_LOGIN",
"description": "<p><code>INVITEE_LOGIN</code> will be removed.</p>",
"reason": "<p><code>INVITEE_LOGIN</code> is no longer a valid field value. Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
},
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "EnterpriseOwnerInfo.pendingCollaborators",
"description": "<p><code>pendingCollaborators</code> will be removed. Use the <code>pendingCollaboratorInvitations</code> field instead.</p>",
"reason": "<p>Repository invitations can now be associated with an email, not only an invitee.</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "jdennes"
}
],
"2020-07-01": [
{
"location": "EnterprisePendingMemberInvitationEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending members consume a license</p>",
"date": "2020-07-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "EnterpriseBillingInfo.seats",
"description": "<p><code>seats</code> will be removed. Use EnterpriseBillingInfo.totalLicenses instead.</p>",
"reason": "<p><code>seats</code> will be replaced with <code>totalLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "EnterpriseBillingInfo.availableSeats",
"description": "<p><code>availableSeats</code> will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.</p>",
"reason": "<p><code>availableSeats</code> will be replaced with <code>totalAvailableLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,129 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,148 @@
{
"2022-07-01": [
{
"location": "Enterprise.userAccounts",
"description": "<p><code>userAccounts</code> will be removed. Use the <code>Enterprise.members</code> field instead.</p>",
"reason": "<p>The <code>Enterprise.userAccounts</code> field is being removed.</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jdennes"
},
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2022-04-01": [
{
"location": "Repository.defaultMergeQueue",
"description": "<p><code>defaultMergeQueue</code> will be removed. Use <code>Repository.mergeQueue</code> instead.</p>",
"reason": "<p><code>defaultMergeQueue</code> will be removed.</p>",
"date": "2022-04-01",
"criticality": "breaking",
"owner": "colinshum"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
},
{
"location": "EnterpriseOutsideCollaboratorEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All outside collaborators consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
},
{
"location": "EnterpriseMemberEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All members consume a license</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-07-01": [
{
"location": "EnterprisePendingMemberInvitationEdge.isUnlicensed",
"description": "<p><code>isUnlicensed</code> will be removed.</p>",
"reason": "<p>All pending members consume a license</p>",
"date": "2020-07-01",
"criticality": "breaking",
"owner": "BrentWheeldon"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "EnterpriseBillingInfo.seats",
"description": "<p><code>seats</code> will be removed. Use EnterpriseBillingInfo.totalLicenses instead.</p>",
"reason": "<p><code>seats</code> will be replaced with <code>totalLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "EnterpriseBillingInfo.availableSeats",
"description": "<p><code>availableSeats</code> will be removed. Use EnterpriseBillingInfo.totalAvailableLicenses instead.</p>",
"reason": "<p><code>availableSeats</code> will be replaced with <code>totalAvailableLicenses</code> to provide more clarity on the value being returned</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "BlakeWilliams"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,129 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,116 @@
{
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2022-07-01": [
{
"location": "Enterprise.userAccounts",
"description": "<p><code>userAccounts</code> will be removed. Use the <code>Enterprise.members</code> field instead.</p>",
"reason": "<p>The <code>Enterprise.userAccounts</code> field is being removed.</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jdennes"
},
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2022-04-01": [
{
"location": "Repository.defaultMergeQueue",
"description": "<p><code>defaultMergeQueue</code> will be removed. Use <code>Repository.mergeQueue</code> instead.</p>",
"reason": "<p><code>defaultMergeQueue</code> will be removed.</p>",
"date": "2022-04-01",
"criticality": "breaking",
"owner": "colinshum"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,129 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,244 @@
{
"2022-10-01": [
{
"location": "UnlockAndResetMergeGroupInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>The current merge group for the repository's default branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "RepositoryVulnerabilityAlert.fixReason",
"description": "<p><code>fixReason</code> will be removed.</p>",
"reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jamestran201"
},
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "ProjectNextFieldType.TRACKS",
"description": "<p><code>TRACKS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.TITLE",
"description": "<p><code>TITLE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.TEXT",
"description": "<p><code>TEXT</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.SINGLE_SELECT",
"description": "<p><code>SINGLE_SELECT</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.REVIEWERS",
"description": "<p><code>REVIEWERS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.REPOSITORY",
"description": "<p><code>REPOSITORY</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.NUMBER",
"description": "<p><code>NUMBER</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.MILESTONE",
"description": "<p><code>MILESTONE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.LINKED_PULL_REQUESTS",
"description": "<p><code>LINKED_PULL_REQUESTS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.LABELS",
"description": "<p><code>LABELS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.ITERATION",
"description": "<p><code>ITERATION</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.DATE",
"description": "<p><code>DATE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.ASSIGNEES",
"description": "<p><code>ASSIGNEES</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "MergeLockedMergeGroupInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>Changes are merged into the repository's default branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "LockMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>The merge queue is locked for the repository's default branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2022-07-01": [
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2022-04-01": [
{
"location": "Repository.defaultMergeQueue",
"description": "<p><code>defaultMergeQueue</code> will be removed. Use <code>Repository.mergeQueue</code> instead.</p>",
"reason": "<p><code>defaultMergeQueue</code> will be removed.</p>",
"date": "2022-04-01",
"criticality": "breaking",
"owner": "colinshum"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

View File

@@ -0,0 +1,149 @@
[
{
"title": "Access to package version deletion preview",
"description": "This preview adds support for the DeletePackageVersion mutation which enables deletion of private package versions.",
"toggled_by": "package-deletes-preview",
"toggled_on": [
"Mutation.deletePackageVersion"
],
"owning_teams": [
"@github/pe-package-registry"
],
"accept_header": "application/vnd.github.package-deletes-preview+json",
"href": "/graphql/overview/schema-previews#access-to-package-version-deletion-preview"
},
{
"title": "Deployments preview",
"description": "This preview adds support for deployments mutations and new deployments features.",
"toggled_by": "flash-preview",
"toggled_on": [
"DeploymentStatus.environment",
"Mutation.createDeploymentStatus",
"Mutation.createDeployment"
],
"owning_teams": [
"@github/c2c-actions-service"
],
"accept_header": "application/vnd.github.flash-preview+json",
"href": "/graphql/overview/schema-previews#deployments-preview"
},
{
"title": "Merge info preview",
"description": "This preview adds support for accessing fields that provide more detailed information about a pull request's merge state.",
"toggled_by": "merge-info-preview",
"toggled_on": [
"PullRequest.canBeRebased",
"PullRequest.mergeStateStatus"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.merge-info-preview+json",
"href": "/graphql/overview/schema-previews#merge-info-preview"
},
{
"title": "Update refs preview",
"description": "This preview adds support for updating multiple refs in a single operation.",
"toggled_by": "update-refs-preview",
"toggled_on": [
"Mutation.updateRefs",
"GitRefname",
"RefUpdate"
],
"owning_teams": [
"@github/reponauts"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview"
},
{
"title": "Access to a repository s dependency graph preview",
"description": "This preview adds support for reading a dependency graph for a repository.",
"toggled_by": "hawkgirl-preview",
"toggled_on": [
"DependencyGraphManifest",
"Repository.dependencyGraphManifests",
"DependencyGraphManifestEdge",
"DependencyGraphManifestConnection",
"DependencyGraphDependency",
"DependencyGraphDependencyEdge",
"DependencyGraphDependencyConnection",
"DependencyGraphPackageRelease.dependencies"
],
"owning_teams": [
"@github/dependency-graph"
],
"accept_header": "application/vnd.github.hawkgirl-preview+json",
"href": "/graphql/overview/schema-previews#access-to-a-repository-s-dependency-graph-preview"
},
{
"title": "Project event details preview",
"description": "This preview adds project, project card, and project column details to project-related issue events.",
"toggled_by": "starfox-preview",
"toggled_on": [
"AddedToProjectEvent.project",
"AddedToProjectEvent.projectCard",
"AddedToProjectEvent.projectColumnName",
"ConvertedNoteToIssueEvent.project",
"ConvertedNoteToIssueEvent.projectCard",
"ConvertedNoteToIssueEvent.projectColumnName",
"MovedColumnsInProjectEvent.project",
"MovedColumnsInProjectEvent.projectCard",
"MovedColumnsInProjectEvent.projectColumnName",
"MovedColumnsInProjectEvent.previousProjectColumnName",
"RemovedFromProjectEvent.project",
"RemovedFromProjectEvent.projectColumnName"
],
"owning_teams": [
"@github/github-projects"
],
"accept_header": "application/vnd.github.starfox-preview+json",
"href": "/graphql/overview/schema-previews#project-event-details-preview"
},
{
"title": "Labels preview",
"description": "This preview adds support for adding, updating, creating and deleting labels.",
"toggled_by": "bane-preview",
"toggled_on": [
"Mutation.createLabel",
"Mutation.deleteLabel",
"Mutation.updateLabel"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.bane-preview+json",
"href": "/graphql/overview/schema-previews#labels-preview"
},
{
"title": "Import project preview",
"description": "This preview adds support for importing projects.",
"toggled_by": "slothette-preview",
"toggled_on": [
"Mutation.importProject"
],
"owning_teams": [
"@github/pe-issues-projects"
],
"accept_header": "application/vnd.github.slothette-preview+json",
"href": "/graphql/overview/schema-previews#import-project-preview"
},
{
"title": "Team review assignments preview",
"description": "This preview adds support for updating the settings for team review assignment.",
"toggled_by": "stone-crop-preview",
"toggled_on": [
"Mutation.updateTeamReviewAssignment",
"TeamReviewAssignmentAlgorithm",
"Team.reviewRequestDelegationEnabled",
"Team.reviewRequestDelegationAlgorithm",
"Team.reviewRequestDelegationMemberCount",
"Team.reviewRequestDelegationNotifyTeam"
],
"owning_teams": [
"@github/pe-pull-requests"
],
"accept_header": "application/vnd.github.stone-crop-preview+json",
"href": "/graphql/overview/schema-previews#team-review-assignments-preview"
}
]

View File

@@ -0,0 +1,278 @@
{
"2023-04-01": [
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
"reason": "<p><code>squashPrTitleUsedAsDefault</code> will be removed.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "github/pull_requests"
},
{
"location": "ProjectV2View.verticalGroupBy",
"description": "<p><code>verticalGroupBy</code> will be removed. Check out the <code>ProjectV2View#vertical_group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#vertical_group_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#vertical_group_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.sortBy",
"description": "<p><code>sortBy</code> will be removed. Check out the <code>ProjectV2View#sort_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#sort_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#sort_by_fields</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "traumverloren"
},
{
"location": "ProjectV2View.groupBy",
"description": "<p><code>groupBy</code> will be removed. Check out the <code>ProjectV2View#group_by_fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#order_by</code> API is deprecated in favour of the more capable <code>ProjectV2View#group_by_field</code> API.</p>",
"date": "2023-04-01",
"criticality": "breaking",
"owner": "alcere"
}
],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
"description": "<p><code>visibleFields</code> will be removed. Check out the <code>ProjectV2View#fields</code> API as an example for the more capable alternative.</p>",
"reason": "<p>The <code>ProjectV2View#visibleFields</code> API is deprecated in favour of the more capable <code>ProjectV2View#fields</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "mattruggio"
},
{
"location": "ProjectNextFieldType.TRACKS",
"description": "<p><code>TRACKS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.TRACKED_BY",
"description": "<p><code>TRACKED_BY</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.TITLE",
"description": "<p><code>TITLE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.TEXT",
"description": "<p><code>TEXT</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.SINGLE_SELECT",
"description": "<p><code>SINGLE_SELECT</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.REVIEWERS",
"description": "<p><code>REVIEWERS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.REPOSITORY",
"description": "<p><code>REPOSITORY</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.NUMBER",
"description": "<p><code>NUMBER</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.MILESTONE",
"description": "<p><code>MILESTONE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.LINKED_PULL_REQUESTS",
"description": "<p><code>LINKED_PULL_REQUESTS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.LABELS",
"description": "<p><code>LABELS</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.ITERATION",
"description": "<p><code>ITERATION</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.DATE",
"description": "<p><code>DATE</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "ProjectNextFieldType.ASSIGNEES",
"description": "<p><code>ASSIGNEES</code> will be removed. Follow the ProjectV2 guide at <a href=\"https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/\">https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/</a>, to find a suitable replacement.</p>",
"reason": "<p>The <code>ProjectNext</code> API is deprecated in favour of the more capable <code>ProjectV2</code> API.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "lukewar"
},
{
"location": "Commit.changedFiles",
"description": "<p><code>changedFiles</code> will be removed. Use <code>changedFilesIfAvailable</code> instead.</p>",
"reason": "<p><code>changedFiles</code> will be removed.</p>",
"date": "2023-01-01",
"criticality": "breaking",
"owner": "adamshwert"
}
],
"2022-10-01": [
{
"location": "RepositoryVulnerabilityAlert.fixReason",
"description": "<p><code>fixReason</code> will be removed.</p>",
"reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jamestran201"
},
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are removed from the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "jhunschejones"
},
{
"location": "DependencyGraphDependency.packageLabel",
"description": "<p><code>packageLabel</code> will be removed. Use normalized <code>packageName</code> field instead.</p>",
"reason": "<p><code>packageLabel</code> will be removed.</p>",
"date": "2022-10-01",
"criticality": "breaking",
"owner": "github/dependency_graph"
}
],
"2022-07-01": [
{
"location": "AddPullRequestToMergeQueueInput.branch",
"description": "<p><code>branch</code> will be removed.</p>",
"reason": "<p>PRs are added to the merge queue for the base branch, the <code>branch</code> argument is now a no-op</p>",
"date": "2022-07-01",
"criticality": "breaking",
"owner": "jhunschejones"
}
],
"2021-10-01": [
{
"location": "ReactionGroup.users",
"description": "<p><code>users</code> will be removed. Use the <code>reactors</code> field instead.</p>",
"reason": "<p>Reactors can now be mannequins, bots, and organizations.</p>",
"date": "2021-10-01",
"criticality": "breaking",
"owner": "synthead"
}
],
"2021-06-21": [
{
"location": "PackageType.DOCKER",
"description": "<p><code>DOCKER</code> will be removed.</p>",
"reason": "<p>DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
"date": "2021-06-21",
"criticality": "breaking",
"owner": "reybard"
}
],
"2021-01-01": [
{
"location": "MergeStateStatus.DRAFT",
"description": "<p><code>DRAFT</code> will be removed. Use PullRequest.isDraft instead.</p>",
"reason": "<p>DRAFT state will be removed from this enum and <code>isDraft</code> should be used instead</p>",
"date": "2021-01-01",
"criticality": "breaking",
"owner": "nplasterer"
}
],
"2020-10-01": [
{
"location": "PullRequest.timeline",
"description": "<p><code>timeline</code> will be removed. Use PullRequest.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
},
{
"location": "Issue.timeline",
"description": "<p><code>timeline</code> will be removed. Use Issue.timelineItems instead.</p>",
"reason": "<p><code>timeline</code> will be removed</p>",
"date": "2020-10-01",
"criticality": "breaking",
"owner": "mikesea"
}
],
"2020-01-01": [
{
"location": "UnassignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
},
{
"location": "AssignedEvent.user",
"description": "<p><code>user</code> will be removed. Use the <code>assignee</code> field instead.</p>",
"reason": "<p>Assignees can now be mannequins.</p>",
"date": "2020-01-01",
"criticality": "breaking",
"owner": "tambling"
}
],
"2019-04-01": [
{
"location": "LegacyMigration.uploadUrlTemplate",
"description": "<p><code>uploadUrlTemplate</code> will be removed. Use <code>uploadUrl</code> instead.</p>",
"reason": "<p><code>uploadUrlTemplate</code> is being removed because it is not a standard URL and adds an extra user step.</p>",
"date": "2019-04-01",
"criticality": "breaking",
"owner": "tambling"
}
]
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -6,9 +6,10 @@ import { getAutomatedPageMiniTocItems } from '../../../lib/get-mini-toc-items.js
import languages from '../../../lib/languages.js'
import { allVersions } from '../../../lib/all-versions.js'
export const GRAPHQL_DATA_DIR = 'src/graphql/data'
/* ADD LANGUAGE KEY */
let previews
let upcomingChanges
const previews = new Map()
const upcomingChanges = new Map()
const changelog = new Map()
const graphqlSchema = new Map()
const miniTocs = new Map()
@@ -22,39 +23,44 @@ export function getGraphqlSchema(version, type) {
if (!graphqlSchema.has(graphqlVersion)) {
graphqlSchema.set(
graphqlVersion,
readCompressedJsonFileFallback(`src/graphql/data/schema-${graphqlVersion}.json`)
readCompressedJsonFileFallback(`${GRAPHQL_DATA_DIR}/${graphqlVersion}/schema.json`)
)
}
return graphqlSchema.get(graphqlVersion)[type]
}
export function getGraphqlChangelog() {
if (!changelog.has('schema')) {
export function getGraphqlChangelog(version) {
const graphqlVersion = getGraphqlVersion(version)
if (!changelog.has(graphqlVersion)) {
changelog.set(
'schema',
readCompressedJsonFileFallbackLazily('./src/graphql/data/changelog.json')()
graphqlVersion,
readCompressedJsonFileFallbackLazily(`${GRAPHQL_DATA_DIR}/${graphqlVersion}/changelog.json`)()
)
}
return changelog.get('schema')
return changelog.get(graphqlVersion)
}
export function getGraphqlBreakingChanges(version) {
const graphqlVersion = getGraphqlVersion(version)
if (!upcomingChanges) {
upcomingChanges = readCompressedJsonFileFallbackLazily(
'./src/graphql/data/upcoming-changes.json'
if (!upcomingChanges.has(graphqlVersion)) {
const data = readCompressedJsonFileFallbackLazily(
`${GRAPHQL_DATA_DIR}/${graphqlVersion}/upcoming-changes.json`
)()
upcomingChanges.set(graphqlVersion, data)
}
return upcomingChanges[graphqlVersion]
return upcomingChanges.get(graphqlVersion)
}
export function getPreviews(version) {
const graphqlVersion = getGraphqlVersion(version)
if (!previews) {
previews = readCompressedJsonFileFallbackLazily('./src/graphql/data/previews.json')()
if (!previews.has(graphqlVersion)) {
const data = readCompressedJsonFileFallbackLazily(
`${GRAPHQL_DATA_DIR}/${graphqlVersion}/previews.json`
)()
previews.set(graphqlVersion, data)
}
return previews[graphqlVersion]
return previews.get(graphqlVersion)
}
export async function getMiniToc(context, type, items, depth = 2, markdownHeading = '') {

View File

@@ -27,9 +27,6 @@ const versionsToBuild = Object.keys(allVersions)
main()
async function main() {
const previewsJson = {}
const upcomingChangesJson = {}
for (const version of versionsToBuild) {
// Get the relevant GraphQL name for the current version
// For example, free-pro-team@latest corresponds to dotcom,
@@ -41,14 +38,22 @@ async function main() {
const previewsPath = getDataFilepath('previews', graphqlVersion)
const safeForPublicPreviews = yaml.load(await getRemoteRawContent(previewsPath, graphqlVersion))
await updateFile(previewsPath, yaml.dump(safeForPublicPreviews))
previewsJson[graphqlVersion] = processPreviews(safeForPublicPreviews)
const previewsJson = processPreviews(safeForPublicPreviews)
await updateStaticFile(
previewsJson,
path.join(graphqlStaticDir, graphqlVersion, 'previews.json')
)
// 2. UPDATE UPCOMING CHANGES
const upcomingChangesPath = getDataFilepath('upcomingChanges', graphqlVersion)
const previousUpcomingChanges = yaml.load(await fs.readFile(upcomingChangesPath, 'utf8'))
const safeForPublicChanges = await getRemoteRawContent(upcomingChangesPath, graphqlVersion)
await updateFile(upcomingChangesPath, safeForPublicChanges)
upcomingChangesJson[graphqlVersion] = await processUpcomingChanges(safeForPublicChanges)
const upcomingChangesJson = await processUpcomingChanges(safeForPublicChanges)
await updateStaticFile(
upcomingChangesJson,
path.join(graphqlStaticDir, graphqlVersion, 'upcoming-changes.json')
)
// 3. UPDATE SCHEMAS
// note: schemas live in separate files per version
@@ -59,12 +64,12 @@ async function main() {
const schemaJsonPerVersion = await processSchemas(latestSchema, safeForPublicPreviews)
await updateStaticFile(
schemaJsonPerVersion,
path.join(graphqlStaticDir, `schema-${graphqlVersion}.json`)
path.join(graphqlStaticDir, graphqlVersion, 'schema.json')
)
// 4. UPDATE CHANGELOG
if (allVersions[version].nonEnterpriseDefault) {
// The Changelog is only build for free-pro-team@latest
// The changelog is only built for free-pro-team@latest
const changelogEntry = await createChangelogEntry(
previousSchemaString,
latestSchema,
@@ -75,15 +80,12 @@ async function main() {
if (changelogEntry) {
prependDatedEntry(
changelogEntry,
path.join(process.cwd(), 'src/graphql/data/changelog.json')
path.join(graphqlStaticDir, graphqlVersion, 'changelog.json')
)
}
}
}
await updateStaticFile(previewsJson, path.join(graphqlStaticDir, 'previews.json'))
await updateStaticFile(upcomingChangesJson, path.join(graphqlStaticDir, 'upcoming-changes.json'))
// Ensure the YAML linter runs before checkinging in files
execSync('npx prettier -w "**/*.{yml,yaml}"')
}

View File

@@ -1,3 +1,5 @@
import { jest } from '@jest/globals'
import readJsonFile from '../../lib/read-json-file.js'
import {
schemaValidator,
@@ -6,10 +8,8 @@ import {
} from '../../src/graphql/lib/validator.js'
import revalidator from 'revalidator'
import { allVersions } from '../../lib/all-versions.js'
import { jest } from '@jest/globals'
import { GRAPHQL_DATA_DIR } from '../../src/graphql/lib/index.js'
const previewsJson = readJsonFile('./src/graphql/data/previews.json')
const upcomingChangesJson = readJsonFile('./src/graphql/data/upcoming-changes.json')
const allVersionValues = Object.values(allVersions)
const graphqlVersions = allVersionValues.map((v) => v.miscVersionName)
const graphqlTypes = readJsonFile('./src/graphql/lib/types.json').map((t) => t.kind)
@@ -17,20 +17,13 @@ const graphqlTypes = readJsonFile('./src/graphql/lib/types.json').map((t) => t.k
describe('graphql json files', () => {
jest.setTimeout(3 * 60 * 1000)
test('static files have versions as top-level keys', () => {
graphqlVersions.forEach((version) => {
expect(version in previewsJson).toBe(true)
expect(version in upcomingChangesJson).toBe(true)
})
})
test('schemas object validation', () => {
// The typeObj is repeated thousands of times in each .json file
// so use a cache of which we've already validated to speed this
// test up significantly.
const typeObjsTested = new Set()
graphqlVersions.forEach((version) => {
const schemaJsonPerVersion = readJsonFile(`src/graphql/data/schema-${version}.json`)
const schemaJsonPerVersion = readJsonFile(`${GRAPHQL_DATA_DIR}/${version}/schema.json`)
// all graphql types are arrays except for queries
graphqlTypes.forEach((type) => {
schemaJsonPerVersion[type].forEach((typeObj) => {
@@ -48,8 +41,9 @@ describe('graphql json files', () => {
test('previews object validation', () => {
graphqlVersions.forEach((version) => {
previewsJson[version].forEach((previewObj) => {
const { valid, errors } = revalidator.validate(previewObj, previewsValidator)
const previews = readJsonFile(`${GRAPHQL_DATA_DIR}/${version}/previews.json`)
previews.forEach((preview) => {
const { valid, errors } = revalidator.validate(preview, previewsValidator)
const errorMessage = JSON.stringify(errors, null, 2)
expect(valid, errorMessage).toBe(true)
})
@@ -58,14 +52,15 @@ describe('graphql json files', () => {
test('upcoming changes object validation', () => {
graphqlVersions.forEach((version) => {
Object.values(upcomingChangesJson[version]).forEach((changes) => {
const upcomingChanges = readJsonFile(`${GRAPHQL_DATA_DIR}/${version}/upcoming-changes.json`)
for (const changes of Object.values(upcomingChanges)) {
// each object value is an array of changes
changes.forEach((changeObj) => {
const { valid, errors } = revalidator.validate(changeObj, upcomingChangesValidator)
const errorMessage = JSON.stringify(errors, null, 2)
expect(valid, errorMessage).toBe(true)
})
})
}
})
})
})

View File

@@ -22,8 +22,7 @@ describe('graphql schema', () => {
}
test('getting the graphql changelog works for dotcom', async () => {
const defaultVersion = allVersions.defaultVersion
const schema = getGraphqlChangelog(defaultVersion)
const schema = getGraphqlChangelog('free-pro-team@latest')
expect(schema).toBeDefined()
})