Merge branch 'main' into main

Author: cmwilson21

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

@@ -9,7 +9,7 @@ The following large repositories are used throughout this checklist, it may be u
 - `github/github`
 - `github/docs-internal`
 
-Additionally, you may want to download:
+Additionally, download:
 
 - [Azure Storage Explorer](https://aka.ms/portalfx/downloadstorageexplorer)
 
@@ -40,7 +40,7 @@ Additionally, you may want to download:
 
   **Note:** You can pass the `--dry-run` flag to scrape only the first 10 pages plus their redirects for testing purposes. **If you use the dry run command, be sure to run the full script without `--dry-run` before you commit the changes.**
 
-## Step 3: Manually remove the search input from the archived docs
+## Step 2: Manually remove the search input from the archived docs
 
 - [ ] Search for `site-search-input` in the compressed Javascript files (should find the file in the `_next` directory). When you find it, use something like https://beautifier.io/ or VSCode to reformat it to be readable. To reformat using VSCode, use the "Format document" option or <kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>F</kbd>. Find `site-search-input` in the file, the result will be enclosed in a function that looks something like... `(0,f.jsx)("input",{"data-testid":"site-search-input",` Delete the entire function. For example, this:
   ```
@@ -88,7 +88,7 @@ Additionally, you may want to download:
   ```
 - [ ] Save the file. If using beautifier, copy and paste the updated file back into your temp directory with the scraped archive content.
 
-## Step 2: Upload the scraped content directory to Azure storage
+## Step 3: Upload the scraped content directory to Azure storage
 
 - [ ] Log in to the Azure portal from Okta. Navigate to the [githubdocs Azure Storage Blob resource](https://portal.azure.com/#@githubazure.onmicrosoft.com/resource/subscriptions/fa6134a7-f27e-4972-8e9f-0cedffa328f1/resourceGroups/docs-production/providers/Microsoft.Storage/storageAccounts/githubdocs/overview).
 - [ ] Click the "Open in Explorer" button to the right of search box. If you haven't already, click the download link to download "Microsoft Azure Storage Explorer." To login to the app, click the plug icon in the left sidebar and click the option to "add an azure account." When you login, you'll need a yubikey to authenticate through Okta.
@@ -97,7 +97,11 @@ Additionally, you may want to download:
 - [ ] Check the log to ensure all files were uploaded successfully.
 - [ ] Remove the temporarily created directory from your `github/docs-internal` checkout.
 
-## Step 4: Deprecate the version in docs-internal
+## Step 4: Create a tag and long-running branch
+
+Create a new tag for the most recent commit on the `main` branch so that we can keep track of where in commit history we removed the GHES release. Create a tag called `enterprise-<release number>-release`. Then from that commit on `main` create a new branch called `enterprise-<release number>-release`. This branch will be long-lived and used to rerender and scrape content that is added after a release is deprecated.
+
+## Step 5: Deprecate the version in docs-internal
 
 In your `docs-internal` checkout:
 
@@ -111,7 +115,7 @@ You can test that the static pages were generated correctly on localhost and on
 
 Poke around several pages, ensure that the stylesheets are working properly, images are rendering properly, and that the search functionality was disabled.
 
-## Step 5: Remove static files for the version
+## Step 6: Remove static files for the version
 
 **Note:** We do not remove the old content for GHES release notes. New release notes can be added after we perform a deprecation in some rare cases, and not removing this content makes it easier for us to re-scrape the content to add to Azure Blob Storage.
 
@@ -121,7 +125,7 @@ Poke around several pages, ensure that the stylesheets are working properly, ima
 - [ ] 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.
 
-## Step 6: Remove the liquid conditionals and content for the version
+## Step 7: Remove the liquid conditionals and content for the version
 
 - [ ] In your `docs-internal` checkout, create a new branch `remove-<version>-markup` branch: `git checkout -b remove-<version>-markup` (you can branch off of `main` or from your `deprecate-<version>` branch, up to you).
 - [ ] Remove the outdated Liquid markup and frontmatter.
@@ -131,17 +135,31 @@ Poke around several pages, ensure that the stylesheets are working properly, ima
   - [ ] Debug any test failures or unexpected results -- it's very likely manual updates will be necessary, the script does a lot of work but doesn't automate everything and can't 100% replace human intent.
 - [ ] When the PR is approved, merge it in to complete the deprecation. This can be merged independently from step 5.
 
-## Step 7: Deprecate the OpenAPI description in `github/github`
+## Step 8: Deprecate the OpenAPI description in `github/github`
 
 - [ ] In `github/github`, edit the release's config file in `app/api/description/config/releases/`, and change `deprecated: false` to `deprecated: true`.
 - [ ] Open a new PR, and get the required code owner approvals. A docs-content team member can approve it for the docs team.
 - [ ] When the PR is approved, [deploy the `github/github` PR](https://thehub.github.com/epd/engineering/devops/deployment/deploying-dotcom/). If you haven't deployed a `github/github` PR before, work with someone that has -- the process isn't too involved depending on how you deploy, but there are a lot of details that can potentially be confusing as you can see from the documentation.
 
 **Note**: you can do this step independently of the other steps after a GHES version is deprecated since it should no longer get updates in github/github. You should plan to get this PR merged as soon as possible, otherwise if you wait too long our OpenAPI automation may re-add the static files that you removed in step 5.
 
-## Step 5: Continue to deprecate the version in docs-internal
+## Step 9: Continue to deprecate the version in docs-internal
 
 - [ ] Open a new PR. Make sure to check the following:
   - [ ] Tests are passing (you may need to include the changes in step 6 to get tests to pass).
   - [ ] The deprecated version renders in preview as expected. You should be able to navigate to `docs.github.com/enterprise/<DEPRECATED VERSION>` to access the docs. You should also be able to navigate to a page that is available in the deprecated version and change the version in the URL to the deprecated version, to test redirects.
-  - [ ] The new oldest supported version renders on staging as expected. You should see a banner on the top of every page for the oldest supported version that notes when the version will be deprecated.
+  - [ ] The new oldest supported version renders on staging as expected. You should see a banner on the top of every page for the oldest supported version that notes when the version will be deprecated.
+
+## Re-scraping a page or all pages
+
+Occasionally, a change will need to be added to our archived enterprise versions. If this occurs, you can check out the `enterprise-<release number>-release` branch and re-scrape the page or all pages using `script/enterprise-server-deprecations/archive-version.js`. To scrape a single page you can use the `—page <page relative path>` option.
+
+For each language, upload the new file to Azure blob storage in the `enterprise` container.
+
+After uploading the new files, you will need to purge the Fastly cache for the single page. From Okta, go to Fastly and select `docs`. Click `Purge` then `Purge URL`. If you need to purge a whole path, just do a `Purge All`
+
+![](/assets/images/fastly_purge.jpg)
+
+Enter the URL or path and do a soft purge.
+
+![](/assets/images/fastly_purge_url.jpg)

.github/actions-scripts/purge-fastly-edge-cache-per-language.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+
+import { languageKeys } from '../../lib/languages.js'
+
+import { makeLanguageSurrogateKey } from '../../middleware/set-fastly-surrogate-key.js'
+import purgeEdgeCache from '../../script/deployment/purge-edge-cache.js'
+
+// This covers things like `/api/webhooks` which isn't language specific.
+await purgeEdgeCache(makeLanguageSurrogateKey())
+
+const languages = process.env.LANGUAGES
+  ? languagesFromString(process.env.LANGUAGES)
+  : // Make sure `en` is first because contributors write mostly in English
+    // and they're most likely wanting to see their landed changes appear
+    // in production as soon as possible.
+    languageKeys.sort((a) => (a === 'en' ? -1 : 1))
+
+for (const language of languages) {
+  await purgeEdgeCache(makeLanguageSurrogateKey(language))
+}
+
+function languagesFromString(str) {
+  const languages = str
+    .split(/,/)
+    .map((x) => x.trim())
+    .filter(Boolean)
+  if (!languages.every((lang) => languageKeys.includes(lang))) {
+    throw new Error(
+      `Unrecognized language code (${languages.find((lang) => !languageKeys.includes(lang))})`
+    )
+  }
+  return languages
+}

.github/actions-scripts/purge-fastly-edge-cache.js

@@ -1,5 +1,21 @@
 #!/usr/bin/env node
-
+import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js'
 import purgeEdgeCache from '../../script/deployment/purge-edge-cache.js'
 
-await purgeEdgeCache()
+// This will purge every response that *contains*
+// `process.env.FASTLY_SURROGATE_KEY || SURROGATE_ENUMS.DEFAULT`.
+// We normally send Surrogate-Key values like:
+//
+//    every-deployment language:en
+//    every-deployment language:fr
+//    every-deployment language:ja
+// or
+//    every-deployment no-language
+//
+// But if you send a purge request for just:
+//
+//    every-deployment
+//
+// It will cover all surrogate keys that contain that.
+// So this the nuclear option for all keys with this prefix.
+await purgeEdgeCache(process.env.FASTLY_SURROGATE_KEY || SURROGATE_ENUMS.DEFAULT)

.github/workflows/add-review-template.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       # Jump through some hoops to work with a multi-line file
       - name: Store review template in variable

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

@@ -81,15 +81,15 @@ jobs:
 
       - if: ${{ env.IS_PUBLIC_BUILD == 'true' }}
         name: Check out main branch
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           ref: 'main'
           persist-credentials: 'false'
           lfs: 'true'
 
       - if: ${{ env.IS_INTERNAL_BUILD == 'true' }}
         name: Check out PR code
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           ref: ${{ env.COMMIT_REF }}
           # To prevent issues with cloning early access content later
@@ -141,7 +141,7 @@ jobs:
 
       - if: ${{ env.IS_INTERNAL_BUILD == 'true' }}
         name: Clone docs-early-access
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}
@@ -154,7 +154,7 @@ jobs:
 
       - if: ${{ env.IS_PUBLIC_BUILD == 'true' }}
         name: Check out user code to temp directory
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           path: ./user-code
           ref: ${{ env.COMMIT_REF }}

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

@@ -40,7 +40,7 @@ jobs:
           creds: ${{ secrets.NONPROD_AZURE_CREDENTIALS }}
 
       - name: Check out repo
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Get preview app info
         env:

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

@@ -23,7 +23,7 @@ concurrency:
 jobs:
   azure-prod-build-and-deploy:
     if: ${{ github.repository == 'github/docs-internal' }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04-xl
     timeout-minutes: 20
     environment:
       name: production
@@ -49,15 +49,11 @@ jobs:
         uses: docker/setup-buildx-action@95cb08cb2672c73d4ffd2f422e6d11953d2a9c70
 
       - name: Check out repo
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           ref: ${{ github.sha }}
           # To prevent issues with cloning early access content later
           persist-credentials: 'false'
-          lfs: 'true'
-
-      - name: Check out LFS objects
-        run: git lfs checkout
 
       - name: Setup node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
@@ -66,7 +62,7 @@ jobs:
           cache: npm
 
       - name: Clone docs-early-access
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}
@@ -143,13 +139,6 @@ jobs:
         run: |
           az webapp deployment slot swap --slot canary --target-slot production -n ghdocs-prod -g docs-prod
 
-      - name: Purge Fastly edge cache
-        env:
-          FASTLY_TOKEN: ${{ secrets.FASTLY_TOKEN }}
-          FASTLY_SERVICE_ID: ${{ secrets.FASTLY_SERVICE_ID }}
-          FASTLY_SURROGATE_KEY: 'every-deployment'
-        run: npm install got && .github/actions-scripts/purge-fastly-edge-cache.js
-
   send-slack-notification-on-failure:
     needs: [azure-prod-build-and-deploy]
     runs-on: ubuntu-latest

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

@@ -60,7 +60,7 @@ jobs:
         uses: docker/setup-buildx-action@95cb08cb2672c73d4ffd2f422e6d11953d2a9c70
 
       - name: Check out repo
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           ref: ${{ env.COMMIT_REF }}
           # To prevent issues with cloning early access content later
@@ -84,7 +84,7 @@ jobs:
           cache: npm
 
       - name: Clone docs-early-access
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}

.github/workflows/browser-test.yml

@@ -49,7 +49,7 @@ jobs:
           discovery type: 'single-node'
 
       - name: Checkout
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           lfs: true
 

.github/workflows/check-broken-links-github-github.yml

@@ -39,13 +39,13 @@ jobs:
           exit 1 # prevents further steps from running
 
       - name: Checkout
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           # To prevent issues with cloning early access content later
           persist-credentials: 'false'
 
       - name: Clone docs-early-access
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}
@@ -92,7 +92,7 @@ jobs:
       - if: ${{ failure() && env.FREEZE != 'true' }}
         name: Get title for issue
         id: check
-        run: echo "::set-output name=title::$(head -1 broken_github_github_links.md)"
+        run: echo "title=$(head -1 broken_github_github_links.md)" >> $GITHUB_OUTPUT
       - if: ${{ failure() && env.FREEZE != 'true'}}
         name: Create issue from file
         id: github-github-broken-link-report

.github/workflows/code-lint.yml

@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repo
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Setup node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048

.github/workflows/codeql.yml

@@ -30,7 +30,7 @@ jobs:
     if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
       - uses: github/codeql-action/init@1ed1437484560351c5be56cf73a48a279d116b78
         with:
           languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp, ruby}

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

@@ -49,7 +49,7 @@ jobs:
       PR_NUMBER: ${{ github.event.pull_request.number }}
     steps:
       - name: check out repo content
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Get preview app info
         env:

.github/workflows/docs-review-collect.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Check out repo content
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Setup Node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048

.github/workflows/enterprise-dates.yml

@@ -36,7 +36,7 @@ jobs:
           exit 1 # prevents further steps from running
 
       - name: Checkout repository code
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Setup Node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048

.github/workflows/link-check-daily.yml

@@ -23,7 +23,7 @@ jobs:
         run: gh --version
 
       - name: Check out repo's default branch
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
       - name: Setup Node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
         with:
@@ -43,7 +43,7 @@ jobs:
 
       - name: Check out docs-early-access too, if internal repo
         if: ${{ github.repository == 'github/docs-internal' }}
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}

.github/workflows/link-check-on-pr.yml

@@ -29,7 +29,7 @@ jobs:
     if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     steps:
       - name: Checkout
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
 
       - name: Setup node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
@@ -50,7 +50,7 @@ jobs:
 
       - name: Check out docs-early-access too, if internal repo
         if: ${{ github.repository == 'github/docs-internal' }}
-        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
         with:
           repository: github/docs-early-access
           token: ${{ secrets.DOCUBOT_REPO_PAT }}