Remove references to review server (#55494)

Author: heiskr

.github/workflows/review-comment.yml

@@ -40,13 +40,13 @@ jobs:
       - name: check out repo content
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - uses: ./.github/actions/node-npm-setup
-      # We're setting the URLs manually until we merge in-progress work. We can utilize review server and its helper functions in a later iteration.
+
       - name: Set APP_URL
         run: |
           if [[ "${{ github.repository }}" == "github/docs-internal" ]]; then
-            echo "APP_URL=https://docs-review.github.com" >> $GITHUB_ENV
+            echo "APP_URL=https://docs-internal-staging-TREE.githubapp.com/en" >> $GITHUB_ENV
           elif [[ "${{ github.repository }}" == 'github/docs' ]]; then
-            echo "APP_URL=https://os-docs-review.github.com" >> $GITHUB_ENV
+            echo "APP_URL=https://adjective-noun-hash-4000.app.github.dev" >> $GITHUB_ENV
           fi
       - name: Find code changes comment
         uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e
@@ -60,13 +60,9 @@ jobs:
         timeout-minutes: 30
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REVIEW_SERVER: o
-          REVIEW_SERVER_ACCESS_TOKEN: ${{ secrets.REVIEW_SERVER_ACCESS_TOKEN }}
           APP_URL: ${{ env.APP_URL }}
           BASE_SHA: ${{ github.event.pull_request.base.sha }}
           HEAD_SHA: ${{ github.event.pull_request.head.sha }}
-          # HEAD_BRANCH isn't necessary for the table comment, but lets us list the branch in the review server menu bar
-          HEAD_BRANCH: ${{ github.event.pull_request.head.ref }}
         run: npm run content-changes-table-comment
       - name: Update comment
         uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043
@@ -88,9 +84,9 @@ jobs:
 
             <details><summary>Table of review links</summary>
 
-            ⚠️ **Warning**: Our review server is experiencing latency issues.
+            **Note**: Please update the URL for your staging server or codespace.
 
-            ${{ steps.changes.outputs.changesTable && 'The table shows the files in the `content` directory that were changed in this pull request. This helps you review your changes on the review server. Changes to the `data` directory are not included in this table.' || '' }}
+            ${{ steps.changes.outputs.changesTable && 'The table shows the files in the `content` directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the `data` directory are not included in this table.' || '' }}
 
             ${{ steps.changes.outputs.changesTable || '_This pull request contains code changes, so we will not generate a table of review links._' }}
 

src/bookmarklets/README.md

@@ -17,13 +17,13 @@ Clicking the bookmark will then execute the JavaScript.
 
 [`src/bookmarklets/view-in-development.js`](./view-in-development.js)
 
-When you're looking at a page on docs.github.com or a review server, clicking this bookmarklet will load the same path you're viewing but on your local server running at localhost:4000.
+When you're looking at a page on docs.github.com, clicking this bookmarklet will load the same path you're viewing but on your local server running at localhost:4000.
 
 ## "View in production" toggle
 
 [`src/bookmarklets/view-in-production.js`](./view-in-production.js)
 
-When you're looking at a page on a review server or your local server running at localhost:4000, clicking this bookmarklet will load the same path you're viewing but on the live documentation site at docs.github.com.
+When you're looking at a page on your local server running at localhost:4000, clicking this bookmarklet will load the same path you're viewing but on the live documentation site at docs.github.com.
 
 ## Open a docs article in VS Code
 

src/deployments/README.md

@@ -3,4 +3,4 @@
 Documentation and build files for our deployments.
 
 - For production deploys: [src/deployments/production](./production/)
-- For staging deploys (includes review servers): [src/deployments/staging](./staging/)
+- For staging deploys: [src/deployments/staging](./staging/)

src/deployments/staging/README.md

@@ -3,7 +3,7 @@
 > [!NOTE]
 > For internal documentation, please see the `Moda` directory in the internal Docs Engineering repo.
 
-When you make a code change and want to review it in a live environment, you can use a staging server. If your change only touches content files e.g. `content/` and `data/` directories, please use the [review server](../../review-server/README.md) instead.
+When you make a code change and want to review it in a live environment, you can use a staging server.
 
 To review code changes on a staging server:
 

src/workflows/content-changes-table-comment-cli.ts

@@ -30,4 +30,4 @@ program
 
 const args = program.args
 const [owner, repo, baseSHA, headSHA] = args
-console.log(await main(owner, repo, baseSHA, headSHA, { isFork: false }))
+console.log(await main(owner, repo, baseSHA, headSHA))

src/workflows/content-changes-table-comment.ts

@@ -24,15 +24,7 @@ import { allVersionShortnames } from '@/versions/lib/all-versions.js'
 import readFrontmatter from '@/frame/lib/read-frontmatter.js'
 import { inLiquid } from './lib/in-liquid'
 
-const {
-  GITHUB_TOKEN,
-  REVIEW_SERVER,
-  REVIEW_SERVER_ACCESS_TOKEN,
-  APP_URL,
-  HEAD_BRANCH,
-  BASE_SHA,
-  HEAD_SHA,
-} = process.env
+const { GITHUB_TOKEN, APP_URL, BASE_SHA, HEAD_SHA } = process.env
 const context = github.context
 
 // the max size of the comment (in bytes)
@@ -46,32 +38,17 @@ const PROD_URL = 'https://docs.github.com'
 
 // When this file is invoked directly from action as opposed to being imported
 if (import.meta.url.endsWith(process.argv[1])) {
-  const isFork = context.payload.pull_request!.head.repo.fork
-
-  const headOwner = context.payload.pull_request!.head.repo.owner.login
-  const headRepo = context.payload.pull_request!.head.repo.name
-
   const baseOwner = context.payload.pull_request!.base.repo.owner.login
   const baseRepo = context.payload.pull_request!.base.repo.name
 
   const baseSHA = BASE_SHA || context.payload.pull_request!.base.sha
   const headSHA = HEAD_SHA || context.payload.pull_request!.head.sha
 
-  const markdownTable = await main(baseOwner, baseRepo, baseSHA, headSHA, {
-    isFork,
-    headOwner,
-    headRepo,
-  })
+  const markdownTable = await main(baseOwner, baseRepo, baseSHA, headSHA)
   core.setOutput('changesTable', markdownTable)
 }
 
-async function main(
-  owner: string,
-  repo: string,
-  baseSHA: string,
-  headSHA: string,
-  { isFork, headOwner, headRepo }: { isFork: boolean; headOwner?: string; headRepo?: string },
-) {
+async function main(owner: string, repo: string, baseSHA: string, headSHA: string) {
   if (!GITHUB_TOKEN) {
     throw new Error(`GITHUB_TOKEN environment variable not set`)
   }
@@ -84,29 +61,6 @@ async function main(
     auth: `token ${GITHUB_TOKEN}`,
   })
 
-  // we'll attach the branch or sha right after this
-  let queryParams = ''
-  if (REVIEW_SERVER) {
-    const searchParams = new URLSearchParams({
-      'review-server-repository': isFork ? `${headOwner}/${headRepo}` : `${owner}/${repo}`,
-    })
-
-    // this token will be available in the internal repo only, skip it for the open source repo
-    if (REVIEW_SERVER_ACCESS_TOKEN) {
-      searchParams.append('review-server-access-token', REVIEW_SERVER_ACCESS_TOKEN)
-    }
-
-    // this script compares with SHAs only, so this allows us
-    // to surface the branch name for the review server bar
-    if (HEAD_BRANCH) {
-      searchParams.append('review-server-branch', HEAD_BRANCH)
-    } else if (headSHA) {
-      searchParams.append('review-server-sha', headSHA)
-    }
-
-    queryParams = `?${searchParams.toString()}`
-  }
-
   // get the list of file changes from the PR
   // this works even if the head commit is from a fork
   const response = await octokit.rest.repos.compareCommitsWithBasehead({
@@ -178,7 +132,7 @@ async function main(
         return
       }
 
-      return makeRow({ file, fileName, sourceUrl, fileUrl, queryParams, data })
+      return makeRow({ file, fileName, sourceUrl, fileUrl, data })
     }),
   )
 
@@ -193,7 +147,6 @@ async function main(
           fileName,
           sourceUrl: file.blob_url,
           fileUrl,
-          queryParams,
           data,
           fromReusable: true,
         })
@@ -239,15 +192,13 @@ type File = {
 function makeRow({
   file,
   fileUrl,
-  queryParams,
   fileName,
   sourceUrl,
   data,
   fromReusable,
 }: {
   file: File
   fileUrl: string
-  queryParams: string
   fileName: string
   sourceUrl: string
   data: any
@@ -282,12 +233,12 @@ function makeRow({
         if (versions.toString() === nonEnterpriseDefaultVersion) {
           // omit version from fpt url
 
-          reviewCell += `[${plan}](${APP_URL}/${fileUrl}${queryParams})<br>`
+          reviewCell += `[${plan}](${APP_URL}/${fileUrl})<br>`
           prodCell += `[${plan}](${PROD_URL}/${fileUrl})<br>`
         } else {
           // for non-versioned releases (ghec) use full url
 
-          reviewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl}${queryParams})<br>`
+          reviewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl})<br>`
           prodCell += `[${plan}](${PROD_URL}/${versions}/${fileUrl})<br>`
         }
       } else if (versions.length) {
@@ -297,7 +248,7 @@ function makeRow({
         prodCell += `${plan}@ `
 
         versions.forEach((version) => {
-          reviewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}${queryParams}) `
+          reviewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}) `
           prodCell += `[${version.split('@')[1]}](${PROD_URL}/${version}/${fileUrl}) `
         })
         reviewCell += '<br>'