Skip to content

Commit 3ff3ded

Browse files
authored
Dont render GraphQL schema previews for dotcom/ghec (#50495)
1 parent a791e5e commit 3ff3ded

File tree

5 files changed

+6
-7
lines changed

5 files changed

+6
-7
lines changed

content/graphql/overview/breaking-changes.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ Breaking changes are any changes that might require action from our integrators.
1919
- **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
2020
- **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.
2121

22+
{% ifversion ghes < 3.13 %}
2223
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).
24+
{% endif %}
2325

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

content/graphql/overview/changelog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Changelog
3-
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.'
3+
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.'
44
redirect_from:
55
- /v4/changelog
66
versions:

content/graphql/overview/schema-previews.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ intro: 'You can preview upcoming features and changes to the {% data variables.p
44
redirect_from:
55
- /v4/previews
66
versions:
7-
fpt: '*'
8-
ghec: '*'
9-
ghes: '*'
7+
ghes: '<=3.12'
108
topics:
119
- API
1210
autogenerated: graphql

src/fixtures/fixtures/graphql-redirects.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@
181181
"/en/v4/object": "/en/graphql/reference/objects",
182182
"/en/v4/object/actorlocation": "/en/graphql/reference/objects#actorlocation",
183183
"/en/v4/object/addedtoprojectevent": "/en/graphql/reference/objects#addedtoprojectevent",
184-
"/en/v4/previews": "/en/graphql/overview/schema-previews",
184+
"/en/v4/previews": "/en/enterprise-server@3.12/graphql/overview/schema-previews",
185185
"/en/v4/public_schema": "/en/graphql/overview/public-schema",
186186
"/en/v4/query": "/en/graphql/reference/queries",
187187
"/en/v4/reference": "/en/graphql/reference",
@@ -383,7 +383,7 @@
383383
"/v4/object": "/en/graphql/reference/objects",
384384
"/v4/object/actorlocation": "/en/graphql/reference/objects#actorlocation",
385385
"/v4/object/addedtoprojectevent": "/en/graphql/reference/objects#addedtoprojectevent",
386-
"/v4/previews": "/en/graphql/overview/schema-previews",
386+
"/v4/previews": "/en/enterprise-server@3.12/graphql/overview/schema-previews",
387387
"/v4/public_schema": "/en/graphql/overview/public-schema",
388388
"/v4/query": "/en/graphql/reference/queries",
389389
"/v4/reference": "/en/graphql/reference",

src/graphql/scripts/sync.js

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ async function main() {
3333
// 1. UPDATE PREVIEWS
3434
const previewsPath = getDataFilepath('previews', graphqlVersion)
3535
const safeForPublicPreviews = yaml.load(await getRemoteRawContent(previewsPath, graphqlVersion))
36-
// await updateFile(previewsPath, yaml.dump(safeForPublicPreviews))
3736
const previewsJson = processPreviews(safeForPublicPreviews)
3837
await updateStaticFile(
3938
previewsJson,

0 commit comments

Comments
 (0)