fix graphql docs automation (#53838)

ebfork · Jan 10, 2025 · 4d49a71 · 4d49a71
1 parent 729ab85
commit 4d49a71
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 5 deletions.
diff --git a/.github/workflows/sync-audit-logs.yml b/.github/workflows/sync-audit-logs.yml
@@ -33,7 +33,7 @@ jobs:
           # need to use a token from a user with access to github/audit-log-allowlists for this step
           GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
         run: |
-          npm run audit-log-sync
+          npm run sync-audit-log
 
       - name: Get the audit-log-allowlists SHA being synced
         id: audit-log-allowlists

diff --git a/.github/workflows/sync-graphql.yml b/.github/workflows/sync-graphql.yml
@@ -25,7 +25,7 @@ jobs:
         env:
           # need to use a token from a user with access to github/github for this step
           GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
-        run: npm run graphql-sync
+        run: npm run sync-graphql
       - name: Create pull request
         id: create-pull-request
         uses: peter-evans/create-pull-request@6cd32fd93684475c31847837f87bb135d40a2b79 # pin @v7.0.3

diff --git a/package.json b/package.json
@@ -20,7 +20,6 @@
     "analyze-text": "tsx src/search/scripts/analyze-text.ts",
     "analyze-comment": "tsx src/events/scripts/analyze-comment-cli.ts",
     "archive-version": "tsx --max-old-space-size=16384 src/ghes-releases/scripts/archive-version.ts",
-    "audit-log-sync": "tsx src/audit-logs/scripts/sync.ts",
     "build": "next build",
     "check-canary-slots": "tsx src/workflows/check-canary-slots.ts",
     "check-content-type": "tsx src/workflows/check-content-type.ts",
@@ -49,7 +48,6 @@
     "general-search-scrape-server": "cross-env NODE_ENV=production PORT=4002 MINIMAL_RENDER=true CHANGELOG_DISABLED=true tsx src/frame/server.ts",
     "ghes-release-scrape-with-server": "cross-env GHES_RELEASE=1 start-server-and-test general-search-scrape-server 4002 general-search-scrape",
     "general-search-scrape-with-server": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test general-search-scrape-server 4002 general-search-scrape",
-    "graphql-sync": "tsx src/graphql/scripts/sync.js",
     "index": "tsx src/search/scripts/index/index-cli autocomplete docs-internal-data",
     "index-ai-search-autocomplete": "tsx src/search/scripts/index/index-cli ai-search-autocomplete",
     "index-general-autocomplete": "tsx src/search/scripts/index/index-cli general-autocomplete",
@@ -88,6 +86,8 @@
     "start-all-languages": "cross-env NODE_ENV=development tsx src/frame/server.ts",
     "start-for-playwright": "cross-env ROOT=src/fixtures/fixtures TRANSLATIONS_FIXTURE_ROOT=src/fixtures/fixtures/translations ENABLED_LANGUAGES=en,ja NODE_ENV=test tsx src/frame/server.ts",
     "symlink-from-local-repo": "tsx src/early-access/scripts/symlink-from-local-repo.js",
+    "sync-audit-log": "tsx src/audit-logs/scripts/sync.ts",
+    "sync-graphql": "tsx src/graphql/scripts/sync.js",
     "sync-rest": "tsx src/rest/scripts/update-files.ts",
     "sync-secret-scanning": "tsx src/secret-scanning/scripts/sync.ts",
     "sync-webhooks": "npx tsx src/rest/scripts/update-files.ts -o webhooks",

diff --git a/src/audit-logs/README.md b/src/audit-logs/README.md
@@ -40,7 +40,7 @@ The workflow runs the `src/audit-logs/scripts/sync.ts` script.
 
 To run the audit log events pipeline locally:
 
-1. Run `npm run audit-log-sync`
+1. Run `npm run sync-audit-log`
 
 ## About this directory
 

diff --git a/src/graphql/scripts/build-changelog.js b/src/graphql/scripts/build-changelog.js
@@ -307,6 +307,7 @@ const CHANGES_TO_IGNORE = [
   ChangeType.TypeDescriptionRemoved,
   ChangeType.TypeDescriptionAdded,
   ChangeType.DirectiveUsageFieldDefinitionAdded,
+  ChangeType.DirectiveUsageArgumentDefinitionAdded,
 ]
 
 export default { createChangelogEntry, cleanPreviewTitle, previewAnchor, prependDatedEntry }