Merge branch 'main' into patch-1

.devcontainer.json

@@ -0,0 +1,18 @@
+// Codespaces environment for docs.github.com
+// For format details, see https://aka.ms/vscode-remote/devcontainer.json 
+{
+    "name": "docs.github.com",
+    "service": "container-doc",
+    "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash",
+        "cSpell.language": ",en"
+    },
+    // Install pre-requisites, and start to serve docs.github.com locally
+    "postCreateCommand": "npm install && npm start",
+    "forwardPorts": [4000],
+    // Visual Studio Code extensions which help authoring for docs.github.com.
+    "extensions": [
+        "yzhang.markdown-all-in-one",
+        "streetsidesoftware.code-spell-checker"
+    ]
+}

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.github/allowed-actions.js

@@ -4,17 +4,13 @@
 // can be added it this list.
 
 module.exports = [
-  'actions/cache@70655ec8323daeeaa7ef06d7c56e1b9191396cbe',
-  'actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16',
-  'actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675',
-  'actions/github-script@5d03ada4b0a753e9460b312e61cc4f8fdeacf163',
-  'actions/github-script@6e5ee1dc1cb3740e5e5e76ad668e3f526edbfe45',
-  'actions/github-script@44b873bc975058192f5279ebe7579496381f575d',
-  'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9',
-  'actions/labeler@5f867a63be70efff62b767459b009290364495eb',
-  'actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d',
-  'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526',
-  'actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8',
+  'actions/cache@0781355a23dac32fd3bac414512f4b903437991a', //actions/cache@v2.1.3
+  'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
+  'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
+  'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0
+  'actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d', //actions/setup-node@v1.4.4
+  'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2
+  'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
   'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
   'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
   'docker://chinthakagodawita/autoupdate-action:v1',

.github/workflows/60-days-stale-check.yml

@@ -1,20 +1,21 @@
 name: 60 Days Stale Check
 on:
   schedule:
-  - cron: "40 16 * * *"  # Run each day at 16:40 UTC / 8:40 PST
+    - cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST
 
 jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }} 
-        stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
-        stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
-        days-before-stale: 60
-        days-before-close: -1
-        only-labels: 'engineering'
-        stale-issue-label: 'stale'
-        stale-pr-label: 'stale'
-
+      - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
+          stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
+          days-before-stale: 60
+          days-before-close: -1
+          only-labels: 'engineering'
+          stale-issue-label: 'stale'
+          stale-pr-label: 'stale'
+          exempt-pr-labels: 'never-stale'
+          exempt-issue-labels: 'never-stale'

.github/workflows/auto-label-prs.yml

@@ -1,12 +1,12 @@
 name: Auto label Pull Requests
 on:
-- pull_request
+  pull_request:
 
 jobs:
   triage:
     if: github.repository == 'github/docs-internal'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
+        with:
+          repo-token: '${{ secrets.GITHUB_TOKEN }}'

.github/workflows/automerge-dependencies.yml

@@ -1,8 +1,16 @@
 name: Auto Merge Dependency Updates
 
 on:
-  - pull_request
-  - pull_request_review
+  pull_request:
+    paths:
+      - 'package*.json'
+      - 'Gemfile*'
+      - 'Dockerfile'
+      - '.github/workflows/**'
+  pull_request_review:
+    types:
+      - edited
+      - submitted
 
 jobs:
   run:

.github/workflows/automerge.yml

@@ -23,14 +23,14 @@ jobs:
     if: contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')
     steps:
       - name: automerge
-        uses: "pascalgn/automerge-action@c9bd182"
+        uses: 'pascalgn/automerge-action@c9bd182'
         env:
-          GITHUB_TOKEN: "${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}"
-          MERGE_METHOD_LABELS: "automerge=merge,autosquash=squash"
-          MERGE_COMMIT_MESSAGE: "pull-request-title"
-          MERGE_METHOD: "merge"
-          MERGE_FORKS: "true"
-          MERGE_RETRIES: "50"
-          MERGE_RETRY_SLEEP: "10000" # ten seconds
-          UPDATE_LABELS: "automerge,autosquash"
-          UPDATE_METHOD: "merge"
+          GITHUB_TOKEN: '${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}'
+          MERGE_METHOD_LABELS: 'automerge=merge,autosquash=squash'
+          MERGE_COMMIT_MESSAGE: 'pull-request-title'
+          MERGE_METHOD: 'merge'
+          MERGE_FORKS: 'true'
+          MERGE_RETRIES: '50'
+          MERGE_RETRY_SLEEP: '10000' # ten seconds
+          UPDATE_LABELS: 'automerge,autosquash'
+          UPDATE_METHOD: 'merge'

.github/workflows/browser-test.yml

@@ -26,7 +26,7 @@ jobs:
       # Even if if doesn't do anything
       - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
         name: Checkout
-        uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
 
       - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
         name: Install

.github/workflows/check-all-english-links.yml

@@ -1,36 +1,32 @@
 name: Check all English links
 
 on:
+  workflow_dispatch:
   schedule:
-    - cron:  "40 19 * * *" # once a day at 19:40 UTC / 11:40 PST
+    - cron: '40 19 * * *' # once a day at 19:40 UTC / 11:40 PST
 
 jobs:
   check_all_english_links:
     name: Check all links
     if: github.repository == 'github/docs-internal'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
-    - name: npm ci
-      run: npm ci
-    - name: npm run build
-      run: npm run build
-    - name: Run script
-      run: script/check-external-links en > broken_links.md
-    - name: Check if any broken links
-      id: check
-      run: |
-        if [ "$(grep 'All links are good' broken_links.md)" ]; then
-          echo ::set-output name=continue::no
-        else
-          echo "::set-output name=continue::yes"
-          echo "::set-output name=title::$(grep 'found on help.github.com' broken_links.md)"
-        fi
-    - if: ${{ steps.check.outputs.continue == 'yes' }}
-      name: Create issue from file
-      uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
-      with:
-        token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
-        title: ${{ steps.check.outputs.title }}
-        content-filepath: ./broken_links.md
-        labels: broken link report
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - name: npm ci
+        run: npm ci
+      - name: npm run build
+        run: npm run build
+      - name: Run script
+        run: script/check-english-links.js > broken_links.md
+      - if: ${{ failure() }}
+        name: Get title for issue
+        id: check
+        run: echo "::set-output name=title::$(head -1 broken_links.md)"
+      - if: ${{ failure() }}
+        name: Create issue from file
+        uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
+        with:
+          token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
+          title: ${{ steps.check.outputs.title }}
+          content-filepath: ./broken_links.md
+          labels: broken link report

.github/workflows/codeql.yml

@@ -1,23 +1,19 @@
-name: "CodeQL analysis"
+name: CodeQL analysis
 
 on:
   push:
     paths:
-    - '**/*.js'
-    - '.github/workflows/codeql.yml'
+      - '**/*.js'
+      - '.github/workflows/codeql.yml'
 
 jobs:
   build:
-
-    strategy:
-      fail-fast: false
-
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
-    - uses: github/codeql-action/init@v1
-      with:
-        languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)
-    - uses: github/codeql-action/analyze@v1
-      continue-on-error: true
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - uses: github/codeql-action/init@v1
+        with:
+          languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)
+      - uses: github/codeql-action/analyze@v1
+        continue-on-error: true

.github/workflows/crowdin.yml

@@ -3,7 +3,7 @@ name: Crowdin Sync
 on:
   workflow_dispatch:
   schedule:
-    - cron: "33 2 * * *" # every day at 2:33 UTC at least until automerge is working 
+    - cron: '33 2 * * *' # every day at 2:33 UTC at least until automerge is working
 
 jobs:
   sync_with_crowdin:
@@ -12,15 +12,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
 
       - name: Sync
         uses: crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688
         with:
           upload_translations: false
           download_translations: true
           create_pull_request: true
-          
+
           # Using a custom config temporarily to avoid clobbering the existing crowdin.yml
           # that is used by the github-help-docs OAuth integration.
           config: 'crowdin.yml'
@@ -35,17 +35,15 @@ jobs:
           crowdin_branch_name: main
 
         env:
-          # Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here 
+          # Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here
           # so that subsequent workflows will be able to run on the pull request created by this workflow.
           GITHUB_TOKEN: ${{ secrets.OCTOGLOT_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
 
           # This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string
           # See "API v2" on https://crowdin.com/project/<your-project>/settings#api
           CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-          
+
           # A personal access token, not to be confused with Crowdin API v1 "API key"
           # See https://crowdin.com/settings#api-key to generate a token
           # This token was created by logging into Crowdin with the octoglot user
           CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-
-

.github/workflows/dry-run-sync-algolia-search-indices.yml

@@ -0,0 +1,31 @@
+name: (Dry run) Algolia
+
+on:
+  workflow_dispatch:
+
+jobs:
+  updateIndices:
+    name: (Dry run) Update indices
+    if: github.repository == 'github/docs-internal'
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
+        with:
+          node-version: 14.x
+      - name: cache node modules
+        uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: npm ci
+        run: npm ci
+      - name: (Dry run) sync indices
+        env:
+          ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm run sync-search-dry-run