Merge pull request github#23902 from github/repo-sync

repo sync

Author: Octomerger

.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md

@@ -121,7 +121,7 @@ Poke around several pages, ensure that the stylesheets are working properly, ima
 
 - [ ] In your `docs-internal` checkout, create a new branch `remove-<version>-static-files` branch: `git checkout -b remove-<version>-static-files` (you can branch off of `main` or from your `deprecate-<version>` branch, up to you).
 - [ ] Run `script/enterprise-server-deprecations/remove-static-files.js` and commit results.
-- [ ] Re-generate the static files by running `script/rest/update-files.js --decorate-only`.
+- [ ] Re-generate the static files by running `src/rest/scripts/update-files.js --decorate-only`.
 - [ ] Open a new PR.
 - [ ] Get a review from docs-engineering and merge. This step can be merged independently from step 6. The purpose of splitting up steps 5 and 6 is to focus the review on specific files.
 

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

@@ -18,7 +18,7 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng
     ```
     script/update-enterprise-dates.js
     ```
-- [ ] Create REST files based on previous version. Copy the latest GHES version of the decorate file from `lib/rest/static/decorated` to a new file in the same directory for the new GHES release. Ex, `cp lib/rest/static/decorated/ghes-3.4.json lib/rest/static/decorated/ghes-3.5.json`.
+- [ ] Create REST files based on previous version. Copy the latest GHES version of the decorate file from `src/rest/data` to a new file in the same directory for the new GHES release. Ex, `cp src/rest/data/ghes-3.4.json src/rest/data/ghes-3.5.json`.
 
 - [ ] Create GraphQL files based on previous version:
 
@@ -94,7 +94,7 @@ This file should be automatically updated, but you can also run `script/update-e
 - [ ] [Freeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) at least 1-2 days before the release, and post an announcement in Slack so everybody knows. It's helpful to freeze the repos before doing the OpenAPI merges to avoid changes to the megabranch while preparing and deploying.
 - [ ] Alert the Neon Squad (formally docs-ecosystem team)  1-2 days before the release to deploy to `github/github`. A PR should already be open in `github/github`, to change the OpenAPI schema config `published` to `true` in `app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml`. They will need to:
   - [ ] Get the required approval from `@github/ecosystem-api-reviewers` then deploy the PR to dotcom. This process generally takes 30-90 minutes.
-  - [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains the decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. **Note:** Don't attempt to resolve conflicts for changes to the `lib/rest/static/decorated` files. Instead delete the existing OpenAPI files for the release version from the megabranch (that is, revert the changes to the `lib/rest/static` decorated JSON files, e.g., from the megabranch do a `git checkout origin/main lib/rest/static/*`), so there are no conflicts to resolve and to ensure that the incoming artifacts are the correct ones.
+  - [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains the decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. **Note:** Don't attempt to resolve conflicts for changes to the `src/rest/data` files. Instead delete the existing OpenAPI files for the release version from the megabranch (that is, revert the changes to the `src/rest/data` decorated JSON files, e.g., from the megabranch do a `git checkout origin/main src/rest/data/*`), so there are no conflicts to resolve and to ensure that the incoming artifacts are the correct ones.
 - [ ] Alert the Ecosystem-API team in #ecosystem-api about the pending release freeze and incoming blocking review of OpenAPI updates in the public REST API description (the `rest-api-descriptions` repo). They'll need to block any future "Update OpenAPI Descriptions" PRs in the public REST API description until after the ship.
   - [ ] Add a blocking review to the auto-generated "Update OpenAPI Descriptions" PR in the public REST API description. (You or they will remove this blocking review once the GHES release ships.)
 

.github/workflows/openapi-decorate.yml

@@ -52,16 +52,16 @@ jobs:
       - name: Copy dereferenced OpenAPI files
         id: rest-api-description
         run: |
-          mkdir ./lib/rest/static/dereferenced
-          find rest-api-description/descriptions-next -type f -name "*.deref.json" -exec sh -c 'cp $1 ./lib/rest/static/dereferenced' sh {} \;
+          mkdir ./src/rest/data/dereferenced
+          find rest-api-description/descriptions-next -type f -name "*.deref.json" -exec sh -c 'cp $1 ./src/rest/data/dereferenced' sh {} \;
           cd rest-api-description
           OPENAPI_COMMIT_SHA=$(git rev-parse HEAD)
           echo "OPENAPI_COMMIT_SHA=$OPENAPI_COMMIT_SHA" >> $GITHUB_OUTPUT
           echo "Copied files from github/rest-api-description repo. Commit SHA: $OPENAPI_COMMIT_SHA"
 
       - name: Decorate the dereferenced OpenAPI schemas
         run: |
-          script/rest/update-files.js --decorate-only --open-source
+          src/rest/scripts/update-files.js --decorate-only --open-source
           git status
           echo "Deleting the cloned github/rest-api-description repo..."
           rm -rf rest-api-description
@@ -74,7 +74,7 @@ jobs:
           # If nothing to commit, exit now. It's fine. No orphans.
           changes=$(git diff --name-only | wc -l)
           if [[ $changes -eq 0 ]]; then
-            echo "There are no changes to commit after running lib/rest/update-files.js. Exiting..."
+            echo "There are no changes to commit after running src/rest/scripts/update-files.js. Exiting..."
             exit 0
           fi
 

.github/workflows/triage-unallowed-contributions.yml

@@ -16,8 +16,6 @@ on:
       - 'Dockerfile*'
       - 'src/**'
       - 'lib/redirects/**'
-      - 'lib/rest/**'
-      - 'lib/webhooks/**'
       - 'package*.json'
       - 'script/**'
       - 'content/actions/deployment/security-hardening-your-deployments/**'
@@ -49,7 +47,7 @@ jobs:
           # Returns list of changed files matching each filter
           filters: |
             openapi:
-              - 'lib/rest/static/**'
+              - 'src/rest/data/**'
             notAllowed:
               - '.devcontainer/**'
               - '.github/actions-scripts/**'
@@ -60,8 +58,6 @@ jobs:
               - 'Dockerfile*'
               - 'src/**'
               - 'lib/redirects/**'
-              - 'lib/rest/**'
-              - 'lib/webhooks/**'
               - 'package*.json'
               - 'scripts/**'
               - 'content/actions/deployment/security-hardening-your-deployments/**'
@@ -83,8 +79,6 @@ jobs:
               'Dockerfile*',
               'src/**',
               'lib/redirects/**',
-              'lib/rest/**',	
-              'lib/webhooks/**',
               'package*.json',
               'scripts/**',
               'content/actions/deployment/security-hardening-your-deployments/**',

Dockerfile.openapi_decorator

@@ -10,11 +10,11 @@ USER node
 
 COPY --chown=node:node package.json /openapi-check
 COPY --chown=node:node package-lock.json /openapi-check
-ADD --chown=node:node script /openapi-check/script
+ADD --chown=node:node src /openapi-check/src
 ADD --chown=node:node lib /openapi-check/lib
 ADD --chown=node:node content /openapi-check/content
 ADD --chown=node:node data /openapi-check/data
 
 RUN npm ci -D
 
-ENTRYPOINT ["node", "/openapi-check/script/rest/openapi-check.js"]
+ENTRYPOINT ["node", "/openapi-check/src/rest/scripts/openapi-check.js"]

content/rest/README.md

@@ -5,6 +5,6 @@ The `/content/rest` directory is where the GitHub REST API docs live!
 * The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable.
 * The `/content/rest/reference` directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using `include` tags.
 
-  The content rendered by `include` tags is sourced from the `/lib/rest/static` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/lib/rest/README.md`](/lib/rest/README.md).
+  The content rendered by `include` tags is sourced from the `/src/rest/data` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/src/rest/README.md`](/src/rest/README.md).
 
   **We cannot accept changes to content that is rendered by `include` tags. However, you can open an issue describing the changes you would like to see.**

lib/all-versions.js

@@ -94,7 +94,7 @@ plans.forEach((planObj) => {
   })
 })
 
-const apiFilesPath = path.join(process.cwd(), 'lib/rest/static/decorated')
+const apiFilesPath = path.join(process.cwd(), 'src/rest/data')
 // This is what determines which versions are calendar date versioned for the REST API docs
 // This is the source of truth for which versions are calendar date versioned.
 fs.readdirSync(apiFilesPath)

middleware/api/webhooks.js

@@ -1,5 +1,5 @@
 import express from 'express'
-import { getWebhook } from '../../lib/webhooks/index.js'
+import { getWebhook } from '../../src/webhooks/lib/index.js'
 import { allVersions } from '../../lib/all-versions.js'
 import { defaultCacheControl } from '../cache-control.js'
 

package.json

@@ -194,7 +194,7 @@
     "prettier": "prettier -w \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"",
     "prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"",
     "prevent-pushes-to-main": "node script/prevent-pushes-to-main.js",
-    "rest-dev": "script/rest/update-files.js",
+    "rest-dev": "src/rest/scripts/update-files.js",
     "show-action-deps": "echo 'Action Dependencies:' && rg '^[\\s|-]*(uses:.*)$' .github -I -N --no-heading -r '$1$2' | sort | uniq | cut -c 7-",
     "start": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon server.js",
     "start-all-languages": "cross-env NODE_ENV=development nodemon server.js",

pages/[versionId]/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.tsx

@@ -2,7 +2,7 @@ import { GetServerSideProps } from 'next'
 import { useRouter } from 'next/router'
 import { useEffect } from 'react'
 
-import { getInitialPageWebhooks } from 'lib/webhooks'
+import { getInitialPageWebhooks } from 'src/webhooks/lib'
 import { getMainContext, MainContext, MainContextT } from 'components/context/MainContext'
 import {
   getAutomatedPageContextFromRequest,