Merge branch 'main' into patch-2

Author: lecoursen

.devcontainer/Dockerfile

@@ -14,3 +14,8 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
 
 # [Optional] Uncomment if you want to install more global node modules
 # RUN su node -c "npm install -g <your-package-list-here>"
+
+# Install the GitHub CLI see:
+# https://github.com/microsoft/vscode-dev-containers/blob/3d59f9fe37edb68f78874620f33dac5a62ef2b93/script-library/docs/github.md
+COPY library-scripts/github-debian.sh /tmp/library-scripts/
+RUN apt-get update && bash /tmp/library-scripts/github-debian.sh

.devcontainer/devcontainer.json

@@ -1,5 +1,6 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/javascript-node
+// -
 {
 	"name": "docs.github.com",
 	"build": {

.devcontainer/library-scripts/github-debian.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+#-------------------------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
+#-------------------------------------------------------------------------------------------------------------
+#
+# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/github.md
+#
+# Syntax: ./github-debian.sh [version]
+
+CLI_VERSION=${1:-"latest"}
+
+set -e
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+export DEBIAN_FRONTEND=noninteractive
+
+# Install curl, apt-transport-https or gpg if missing
+if ! dpkg -s curl ca-certificates > /dev/null 2>&1; then
+    if [ ! -d "/var/lib/apt/lists" ] || [ "$(ls /var/lib/apt/lists/ | wc -l)" = "0" ]; then
+        apt-get update
+    fi
+    apt-get -y install --no-install-recommends curl ca-certificates
+fi
+
+# Get latest release number if latest is specified
+if [ "${CLI_VERSION}" = "latest" ] ||  [ "${CLI_VERSION}" = "current" ] ||  [ "${CLI_VERSION}" = "lts" ]; then
+    LATEST_RELEASE=$(curl -sSL -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/cli/cli/releases?per_page=1&page=1")
+    CLI_VERSION=$(echo ${LATEST_RELEASE} | grep -oE 'tag_name":\s*"v[^"]+' | sed -n '/tag_name":\s*"v/s///p')
+fi
+
+# Install the GitHub CLI
+echo "Downloading github CLI..."
+curl -OsSL https://github.com/cli/cli/releases/download/v${CLI_VERSION}/gh_${CLI_VERSION}_linux_amd64.deb
+echo "Installing github CLI..."
+apt-get install ./gh_${CLI_VERSION}_linux_amd64.deb
+echo "Removing github CLI deb file after installation..."
+rm -rf ./gh_${CLI_VERSION}_linux_amd64.deb
+echo "Done!"

.github/actions-scripts/content-changes-table-comment.js

@@ -36,7 +36,7 @@ for (const file of articleFiles) {
   const sourceUrl = file.blob_url
   const fileName = file.filename.slice(pathPrefix.length)
   const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
-  const previewLink = `https://${APP_URL}/${fileUrl}`
+  const previewLink = `${APP_URL}/${fileUrl}`
   const productionLink = `https://docs.github.com/${fileUrl}`
   let markdownLine = ''
 

.github/actions-scripts/get-preview-app-info.sh

@@ -10,32 +10,28 @@
 [[ -z $GITHUB_REPOSITORY ]] && { echo "Missing GITHUB_REPOSITORY. Exiting."; exit 1; }
 [[ -z $PR_NUMBER ]] && { echo "Missing PR_NUMBER. Exiting."; exit 1; }
 [[ -z $GITHUB_ENV ]] && { echo "Missing GITHUB_ENV. Exiting."; exit 1; }
+[[ -z $APP_NAME_SEED ]] && { echo "Missing APP_NAME_SEED. Exiting."; exit 1; }
 
-# Number of resource groups that we use to split preview envs across
-PREVIEW_ENV_RESOURCE_GROUPS=4
+PREVIEW_ENV_LOCATION="eastus"
+echo "PREVIEW_ENV_LOCATION=${PREVIEW_ENV_LOCATION}" >> $GITHUB_ENV
 
 REPO_NAME="${GITHUB_REPOSITORY#*\/}"
 echo "REPO_NAME=${REPO_NAME}" >> $GITHUB_ENV
 
 DEPLOYMENT_NAME="${REPO_NAME}-pr-${PR_NUMBER}"
 echo "DEPLOYMENT_NAME=${DEPLOYMENT_NAME}" >> $GITHUB_ENV
 
-RESOURCE_GROUP="preview-env-${REPO_NAME}-$((${PR_NUMBER} % ${PREVIEW_ENV_RESOURCE_GROUPS}))"
-echo "RESOURCE_GROUP=${RESOURCE_GROUP}" >> $GITHUB_ENV
+APP_NAME_BASE="${REPO_NAME}-preview-${PR_NUMBER}"
+echo "APP_NAME_BASE=${APP_NAME_BASE}" >> $GITHUB_ENV
 
-APP_NAME_SHORT="${REPO_NAME}-preview-${PR_NUMBER}"
-echo "APP_NAME_SHORT=${APP_NAME_SHORT}" >> $GITHUB_ENV
+# pseudo random string so guessing a preview env URL is more difficult
+APP_SHA=$(echo -n "${APP_NAME_SEED}-${APP_NAME_BASE}" | sha1sum | cut -c1-6)
 
-IMAGE_REPO="${GITHUB_REPOSITORY}/pr-${PR_NUMBER}"
-echo "IMAGE_REPO=${IMAGE_REPO}" >> $GITHUB_ENV
-
-# Since this incurs a network request and can be slow, we make it optional
-if [ $FULL_APP_INFO ]; then
-  APP_INFO=$(az webapp list -g ${RESOURCE_GROUP} --query "[?tags.DocsAppName == '${APP_NAME_SHORT}'].{defaultHostName:defaultHostName, name:name} | [0]")
+APP_NAME="${APP_NAME_BASE}-${APP_SHA}"
+echo "APP_NAME=${APP_NAME}" >> $GITHUB_ENV
 
-  APP_URL=$(echo $APP_INFO | jq '.defaultHostName' | tr -d '"')
-  echo "APP_URL=${APP_URL}" >> $GITHUB_ENV
+APP_URL="https://${APP_NAME}.${PREVIEW_ENV_LOCATION}.azurecontainer.io"
+echo "APP_URL=${APP_URL}" >> $GITHUB_ENV
 
-  APP_NAME_FULL=$(echo $APP_INFO | jq '.name' | tr -d '"')
-  echo "APP_NAME_FULL=${APP_NAME_FULL}" >> $GITHUB_ENV
-fi
+IMAGE_REPO="${GITHUB_REPOSITORY}/pr-${PR_NUMBER}"
+echo "IMAGE_REPO=${IMAGE_REPO}" >> $GITHUB_ENV

.github/workflows/azure-preview-env-deploy.yml

@@ -40,11 +40,13 @@ jobs:
     timeout-minutes: 15
     environment:
       name: preview-env-${{ github.event.number }}
-      url: ${{ steps.deploy.outputs.defaultHostName }}
+      # The environment variable is computer later in this job in
+      # the "Get preview app info" step.
+      # That script sets environment variables which is used by Actions
+      # to link a PR to a list of environments later.
+      url: ${{ env.APP_URL }}
     env:
       PR_NUMBER: ${{ github.event.number || github.event.inputs.PR_NUMBER }}
-      NONPROD_REGISTRY_USERNAME: ghdocs
-      APP_LOCATION: eastus
       ENABLE_EARLY_ACCESS: ${{ github.repository == 'github/docs-internal' }}
 
     steps:
@@ -57,7 +59,7 @@ jobs:
         uses: azure/docker-login@81744f9799e7eaa418697cb168452a2882ae844a
         with:
           login-server: ${{ secrets.NONPROD_REGISTRY_SERVER }}
-          username: ${{ env.NONPROD_REGISTRY_USERNAME }}
+          username: ${{ secrets.NONPROD_REGISTRY_USERNAME }}
           password: ${{ secrets.NONPROD_REGISTRY_PASSWORD }}
 
       - name: Set up Docker Buildx
@@ -75,6 +77,8 @@ jobs:
         run: git lfs checkout
 
       - name: Get preview app info
+        env:
+          APP_NAME_SEED: ${{ secrets.PREVIEW_ENV_NAME_SEED }}
         run: .github/actions-scripts/get-preview-app-info.sh
 
       - name: 'Set env vars'
@@ -144,23 +148,24 @@ jobs:
       # Succeed despite any non-zero exit code (e.g. if there is no deployment to cancel)
       - name: 'Cancel any existing deployments for this PR'
         run: |
-          az deployment group cancel --name ${{ env.DEPLOYMENT_NAME }} -g ${{ env.RESOURCE_GROUP }} || true
+          az deployment group cancel --name ${{ env.DEPLOYMENT_NAME }} -g ${{ secrets.PREVIEW_ENV_RESOURCE_GROUP }} || true
 
       # Deploy ARM template is idempotent
       # Note: once the resources exist the image tag must change for a new deployment to occur (the image tag includes workflow run number, run attempt, as well as sha)
       - name: Run ARM deploy
         id: deploy
         uses: azure/arm-deploy@841b12551939c88af8f6df767c24c38a5620fd0d
         with:
-          resourceGroupName: ${{ env.RESOURCE_GROUP }}
+          resourceGroupName: ${{ secrets.PREVIEW_ENV_RESOURCE_GROUP }}
           subscriptionId: ${{ secrets.NONPROD_SUBSCRIPTION_ID }}
           template: ./azure-preview-env-template.json
           deploymentName: ${{ env.DEPLOYMENT_NAME }}
-          parameters: appName="${{ env.APP_NAME_SHORT }}"
-            location="${{ env.APP_LOCATION }}"
-            linuxFxVersion="DOCKER|${{ env.DOCKER_IMAGE }}"
-            dockerRegistryUrl="https://${{ secrets.NONPROD_REGISTRY_SERVER }}"
-            dockerRegistryUsername="${{ env.NONPROD_REGISTRY_USERNAME }}"
+          parameters: appName="${{ env.APP_NAME }}"
+            location="${{ env.PREVIEW_ENV_LOCATION }}"
+            containerImage="${{ env.DOCKER_IMAGE }}"
+            dockerRegistryUrl="${{ secrets.NONPROD_REGISTRY_SERVER }}"
+            dockerRegistryUsername="${{ secrets.NONPROD_REGISTRY_USERNAME }}"
             dockerRegistryPassword="${{ secrets.NONPROD_REGISTRY_PASSWORD }}"
-
-      - run: echo ${{ steps.deploy.outputs.defaultHostName }}
+          # this shows warnings in the github actions console, because the flag is passed through a validation run,
+          # but it *is* functional during the actual execution
+          additionalArguments: --no-wait

.github/workflows/azure-preview-env-destroy.yml

@@ -24,7 +24,6 @@ jobs:
     timeout-minutes: 5
     env:
       PR_NUMBER: ${{ github.event.number || github.event.inputs.PR_NUMBER }}
-      NONPROD_REGISTRY_NAME: ghdocs
 
     steps:
       - name: 'Az CLI login'
@@ -37,25 +36,25 @@ jobs:
 
       - name: Get preview app info
         env:
-          FULL_APP_INFO: 1
+          APP_NAME_SEED: ${{ secrets.PREVIEW_ENV_NAME_SEED }}
         run: .github/actions-scripts/get-preview-app-info.sh
 
       # Succeed despite any non-zero exit code (e.g. if there is no deployment to cancel)
       - name: 'Cancel any in progress deployments'
         run: |
-          az deployment group cancel --name ${{ env.DEPLOYMENT_NAME }} -g ${{ env.RESOURCE_GROUP }} || true
+          az deployment group cancel --name ${{ env.DEPLOYMENT_NAME }} -g ${{ secrets.PREVIEW_ENV_RESOURCE_GROUP }} || true
 
       # Delete web app (which will also delete the App Service plan)
       # This will succeed even if the app doesn't exist / has already been deleted
       - name: 'Delete App Service App (which will also delete the App Service plan)'
         run: |
-          az webapp delete -n ${{ env.APP_NAME_FULL }} -g ${{ env.RESOURCE_GROUP }}
+          az container delete -n ${{ env.APP_NAME }} -g ${{ secrets.PREVIEW_ENV_RESOURCE_GROUP }} -y
 
       # Untag all images under this PR's container registry repo - the container registry will automatically remove untagged images.
       # This will fail if the IMAGE_REPO doesn't exist, but we don't care
       - name: 'Untag all docker images for this PR'
         run: |
-          az acr repository delete -n ${{ env.NONPROD_REGISTRY_NAME }} --repository ${{ env.IMAGE_REPO }} -y || true
+          az acr repository delete -n ${{ secrets.NONPROD_REGISTRY_NAME }} --repository ${{ env.IMAGE_REPO }} -y || true
 
       # Remove all GitHub deployments from this environment and remove the environment
       - uses: strumwolf/delete-deployment-environment@45c821e46baa405e25410700fe2e9643929706a0

.github/workflows/content-changes-table-comment.yml

@@ -48,17 +48,12 @@ jobs:
     env:
       PR_NUMBER: ${{ github.event.pull_request.number }}
     steps:
-      - name: 'Az CLI login'
-        uses: azure/login@1f63701bf3e6892515f1b7ce2d2bf1708b46beaf
-        with:
-          creds: ${{ secrets.NONPROD_AZURE_CREDENTIALS }}
-
       - name: check out repo content
         uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
 
       - name: Get preview app info
         env:
-          FULL_APP_INFO: 1
+          APP_NAME_SEED: ${{ secrets.PREVIEW_ENV_NAME_SEED }}
         run: .github/actions-scripts/get-preview-app-info.sh
 
       - name: Setup Node

.github/workflows/prod-build-deploy-azure.yml

@@ -90,12 +90,12 @@ jobs:
         run: |
           sed 's|#{IMAGE}#|${{ env.DOCKER_IMAGE }}|g' docker-compose.prod.tmpl.yaml > docker-compose.prod.yaml
 
-      - name: 'Apply updated docker-compose.prod.yaml config to preview slot'
+      - name: 'Apply updated docker-compose.prod.yaml config to staging slot'
         run: |
-          az webapp config container set --multicontainer-config-type COMPOSE --multicontainer-config-file docker-compose.prod.yaml --slot preview -n ghdocs-prod -g docs-prod
+          az webapp config container set --multicontainer-config-type COMPOSE --multicontainer-config-file docker-compose.prod.yaml --slot staging -n ghdocs-prod -g docs-prod
 
-      # Watch preview slot instances to see when all the instances are ready
-      - name: Check that preview slot is ready
+      # Watch staging slot instances to see when all the instances are ready
+      - name: Check that staging slot is ready
         uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
         env:
           CHECK_INTERVAL: 10000
@@ -115,7 +115,7 @@ jobs:
             let hasStopped = false
             const waitDuration = parseInt(process.env.CHECK_INTERVAL, 10) || 10000
             async function doCheck() {
-              const states = getStatesForSlot('preview')
+              const states = getStatesForSlot('staging')
               console.log(`Instance states:`, states)
 
               // We must wait until at-least 1 instance has STOPPED to know we're looking at the "next" deployment and not the "previous" one
@@ -136,10 +136,10 @@ jobs:
 
             doCheck()
 
-      # TODO - make a request to verify the preview app version aligns with *this* github action workflow commit sha
-      - name: 'Swap preview slot to production'
+      # TODO - make a request to verify the staging app version aligns with *this* github action workflow commit sha
+      - name: 'Swap staging slot to production'
         run: |
-          az webapp deployment slot swap --slot preview --target-slot production -n ghdocs-prod -g docs-prod
+          az webapp deployment slot swap --slot staging --target-slot production -n ghdocs-prod -g docs-prod
 
       - name: Purge Fastly edge cache
         env:

.github/workflows/test.yml

@@ -51,6 +51,53 @@ jobs:
           # Enables cloning the Early Access repo later with the relevant PAT
           persist-credentials: 'false'
 
+      - name: Figure out which docs-early-access branch to checkout, if internal repo
+        if: ${{ github.repository == 'github/docs-internal' }}
+        id: check-early-access
+        uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
+        env:
+          BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+        with:
+          github-token: ${{ secrets.DOCUBOT_REPO_PAT }}
+          result-encoding: string
+          script: |
+            // If being run from a PR, this becomes 'my-cool-branch'.
+            // If run on main, with the `workflow_dispatch` action for
+            // example, the value becomes 'main'.
+            const { BRANCH_NAME } = process.env
+            try {
+              const response = await github.repos.getBranch({
+                owner: 'github',
+                repo: 'docs-early-access',
+                BRANCH_NAME,
+              })
+              console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)
+              return BRANCH_NAME
+            } catch (err) {
+              if (err.status === 404) {
+                console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)
+                return 'main'
+              }
+              throw err
+            }
+
+      - name: Check out docs-early-access too, if internal repo
+        if: ${{ github.repository == 'github/docs-internal' }}
+        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+        with:
+          repository: github/docs-early-access
+          token: ${{ secrets.DOCUBOT_REPO_PAT }}
+          path: docs-early-access
+          ref: ${{ steps.check-early-access.outputs.result }}
+
+      - name: Merge docs-early-access repo's folders
+        if: ${{ github.repository == 'github/docs-internal' }}
+        run: |
+          mv docs-early-access/assets assets/images/early-access
+          mv docs-early-access/content content/early-access
+          mv docs-early-access/data data/early-access
+          rm -r docs-early-access
+
       - name: Checkout LFS objects
         run: git lfs checkout
 
@@ -78,13 +125,6 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Clone early access
-        if: ${{ github.repository == 'github/docs-internal' }}
-        run: script/early-access/clone-for-build.js
-        env:
-          DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
-          GIT_BRANCH: ${{ github.head_ref || github.ref }}
-
       - name: Cache nextjs build
         uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed
         with: