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

Dont render GraphQL schema previews for dotcom/ghec (#50495)

This commit is contained in:
Rachael Sewell
2024-05-07 16:49:03 -07:00
committed by GitHub
parent a791e5e5e6
commit 3ff3dede54
5 changed files with 6 additions and 7 deletions

View File

@@ -19,7 +19,9 @@ Breaking changes are any changes that might require action from our integrators.
- **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
- **Dangerous:** Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.
{% ifversion ghes < 3.13 %}
We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a [schema preview](/graphql/overview/schema-previews).
{% endif %}
We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.

View File

@@ -1,6 +1,6 @@
---
title: Changelog
intro: 'The GraphQL schema changelog is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes, schema previews, and upcoming breaking changes.'
intro: 'The GraphQL schema changelog is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes{% ifversion ghes < 3.13 %}, schema previews,{% endif %} and upcoming breaking changes.'
redirect_from:
- /v4/changelog
versions:

View File

@@ -4,9 +4,7 @@ intro: 'You can preview upcoming features and changes to the {% data variables.p
redirect_from:
- /v4/previews
versions:
fpt: '*'
ghec: '*'
ghes: '*'
ghes: '<=3.12'
topics:
- API
autogenerated: graphql

View File

@@ -181,7 +181,7 @@
"/en/v4/object": "/en/graphql/reference/objects",
"/en/v4/object/actorlocation": "/en/graphql/reference/objects#actorlocation",
"/en/v4/object/addedtoprojectevent": "/en/graphql/reference/objects#addedtoprojectevent",
"/en/v4/previews": "/en/graphql/overview/schema-previews",
"/en/v4/previews": "/en/enterprise-server@3.12/graphql/overview/schema-previews",
"/en/v4/public_schema": "/en/graphql/overview/public-schema",
"/en/v4/query": "/en/graphql/reference/queries",
"/en/v4/reference": "/en/graphql/reference",
@@ -383,7 +383,7 @@
"/v4/object": "/en/graphql/reference/objects",
"/v4/object/actorlocation": "/en/graphql/reference/objects#actorlocation",
"/v4/object/addedtoprojectevent": "/en/graphql/reference/objects#addedtoprojectevent",
"/v4/previews": "/en/graphql/overview/schema-previews",
"/v4/previews": "/en/enterprise-server@3.12/graphql/overview/schema-previews",
"/v4/public_schema": "/en/graphql/overview/public-schema",
"/v4/query": "/en/graphql/reference/queries",
"/v4/reference": "/en/graphql/reference",

View File

@@ -33,7 +33,6 @@ async function main() {
// 1. UPDATE PREVIEWS
const previewsPath = getDataFilepath('previews', graphqlVersion)
const safeForPublicPreviews = yaml.load(await getRemoteRawContent(previewsPath, graphqlVersion))
// await updateFile(previewsPath, yaml.dump(safeForPublicPreviews))
const previewsJson = processPreviews(safeForPublicPreviews)
await updateStaticFile(
previewsJson,