Enum value THREADS was added to enum SocialAccountProvider
Social news aggregation and discussion website.
" }, + { + "name": "THREADS", + "description": "Microblogging social platform.
" + }, { "name": "TWITCH", "description": "Live-streaming service.
" diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index 134049b6a71c..410d11a9f537 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -59330,6 +59330,11 @@ enum SocialAccountProvider @docsCategory(name: "users") { """ REDDIT + """ + Microblogging social platform. + """ + THREADS + """ Live-streaming service. """ diff --git a/src/graphql/data/ghec/schema-users.json b/src/graphql/data/ghec/schema-users.json index d4cf542c879b..20b7c5244865 100644 --- a/src/graphql/data/ghec/schema-users.json +++ b/src/graphql/data/ghec/schema-users.json @@ -7536,6 +7536,10 @@ "name": "REDDIT", "description": "Social news aggregation and discussion website.
" }, + { + "name": "THREADS", + "description": "Microblogging social platform.
" + }, { "name": "TWITCH", "description": "Live-streaming service.
" diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 134049b6a71c..410d11a9f537 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -59330,6 +59330,11 @@ enum SocialAccountProvider @docsCategory(name: "users") { """ REDDIT + """ + Microblogging social platform. + """ + THREADS + """ Live-streaming service. """ diff --git a/src/graphql/scripts/sync.ts b/src/graphql/scripts/sync.ts index 4d84455e9d06..2cb08cb86f0c 100755 --- a/src/graphql/scripts/sync.ts +++ b/src/graphql/scripts/sync.ts @@ -10,6 +10,8 @@ import processPreviews from './utils/process-previews' import processUpcomingChanges from './utils/process-upcoming-changes' import processSchemas from './utils/process-schemas' import { bucketSchemaByCategory, writeCategoryFiles } from './utils/bucket-by-category' +import { syncCategoryContentFiles, type CategoryPresence } from './utils/sync-category-content' +import { ALL_KIND_KEYS } from '@/graphql/lib/categories' import { prependDatedEntry, createChangelogEntry, @@ -65,6 +67,12 @@ if (!process.env.GITHUB_TOKEN) { const versionsToBuild = Object.keys(allVersions) +// Tracks, per category, the set of docs versions in which the category has at +// least one type. Populated inside the per-version loop and consumed after it +// to manage the per-category content pages. Declared before `main()` runs so +// the loop never reads it in the temporal dead zone. +const categoryPresence: CategoryPresence = new Map() + main() const allIgnoredChanges: IgnoredChange[] = [] @@ -145,6 +153,17 @@ async function main() { const perCategoryFiles = bucketSchemaByCategory(schemaJsonPerVersion) await writeCategoryFiles(path.join(graphqlStaticDir, graphqlVersion), perCategoryFiles) + // Record which categories have at least one type in this version so the + // content pages and their `versions` frontmatter can be managed after the + // loop. `version` is the docs version key (e.g. `enterprise-server@3.22`), + // which is the format `convertVersionsToFrontmatter` expects. + for (const [cat, bucket] of perCategoryFiles.entries()) { + const hasTypes = ALL_KIND_KEYS.some((kind) => (bucket[kind]?.length ?? 0) > 0) + if (!hasTypes) continue + if (!categoryPresence.has(cat)) categoryPresence.set(cat, new Set()) + categoryPresence.get(cat)!.add(version) + } + // 4. UPDATE CHANGELOG if (allVersions[version].nonEnterpriseDefault) { // The changelog is only built for free-pro-team@latest @@ -173,6 +192,11 @@ async function main() { } } + // Manage the per-category content pages (create new categories, delete + // emptied ones, narrow `versions` frontmatter) plus the reference index + // children and disappearance redirects, based on the presence collected above. + await syncCategoryContentFiles(categoryPresence) + // Ensure the YAML linter runs before checkinging in files execSync('npx prettier -w "**/*.{yml,yaml}"') diff --git a/src/graphql/scripts/utils/sync-category-content.ts b/src/graphql/scripts/utils/sync-category-content.ts new file mode 100644 index 000000000000..02a58d150c5d --- /dev/null +++ b/src/graphql/scripts/utils/sync-category-content.ts @@ -0,0 +1,177 @@ +import fs from 'fs/promises' +import path from 'path' +import walk from 'walk-sync' +import matter from '@gr2m/gray-matter' +import { isEqual } from 'lodash-es' + +import { + updateContentDirectory, + convertVersionsToFrontmatter, +} from '@/automated-pipelines/lib/update-markdown' +import { CATEGORIES, OTHER_CATEGORY, categoryTitle } from '@/graphql/lib/categories' + +// Default directory holding the per-category GraphQL reference content pages. +// Overridable via options for tests; production always uses this path. +const DEFAULT_CONTENT_DIR = path.join('content', 'graphql', 'reference') +// Value of the `autogenerated` frontmatter on managed category pages. The +// content-directory helper uses this to know which files it owns (and may +// therefore delete when a category empties). +const AUTOGENERATED_TYPE = 'graphql' +// Breadcrumb category the reference pages sit under in the sidebar. +const CATEGORY_BREADCRUMB = 'Explore the schema reference' + +// Maps a category slug to the set of docs version keys (e.g. +// `free-pro-team@latest`, `enterprise-server@3.22`) in which the category has +// at least one type. Built by sync.ts from the per-version buckets. +export type CategoryPresence = Map