Merge branch 'main' into ruby-guide-patch

Author: ramyaparimi

.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!"

.dockerignore

@@ -10,3 +10,5 @@ tests/
 lib/rest/static/dereferenced
 # Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build
 docs-early-access/
+# During the preview deploy untrusted user code may be cloned into this directory
+user-code/

.github/CODEOWNERS

@@ -11,7 +11,6 @@
 /script/ @github/docs-engineering
 /includes/ @github/docs-engineering
 /lib/search/popular-pages.json @github/docs-engineering
-app.json @github/docs-engineering
 Dockerfile @github/docs-engineering
 package-lock.json @github/docs-engineering
 package.json @github/docs-engineering

.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