Merge branch 'main' into patch-1

.github/ISSUE_TEMPLATE/improve-the-site.md

@@ -22,7 +22,7 @@ Check to make sure someone hasn't already opened a similar issue: https://github
 
 ### What is the current behavior?
 
-<!-- include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. -->
+<!-- Include links to articles where you're seeing a problem, screenshots, what browser you're using, etc. -->
 
 ### What changes are you suggesting?
 

.github/allowed-actions.js

@@ -12,6 +12,8 @@ module.exports = [
   'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2
   'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
   'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
+  'crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120',
+  'cschleiden/actions-linter@43fd4e08e52ed40c0e2782dc2425694388851576',
   'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
   'docker://chinthakagodawita/autoupdate-action:v1',
   'fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289',
@@ -19,7 +21,7 @@ module.exports = [
   'github/codeql-action/init@v1',
   'ianwalter/puppeteer@12728ddef82390d1ecd4732fb543f62177392fbb',
   'juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8',
-  'juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b',
+  'juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9',
   'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512',
   'lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8',
   'pascalgn/automerge-action@c9bd182',
@@ -31,7 +33,7 @@ module.exports = [
   'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
   'repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d',
   'someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd',
-  'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0',
+  'tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61',
   'EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575',
   'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58'
 ]

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

@@ -5,6 +5,7 @@ on:
 
 jobs:
   stale:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4

.github/workflows/automerge-dependencies.yml

@@ -14,9 +14,10 @@ on:
 
 jobs:
   run:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     steps:
-      - uses: tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0
+      - uses: tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           allowed-actors: dependabot[bot]

.github/workflows/automerge.yml

@@ -20,7 +20,7 @@ on:
 jobs:
   automerge:
     runs-on: ubuntu-latest
-    if: contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')
+    if: (contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')) && (github.repository == 'github/docs-internal' || github.repository == 'github/docs')
     steps:
       - name: automerge
         uses: 'pascalgn/automerge-action@c9bd182'

.github/workflows/autoupdate-branch.yml

@@ -5,8 +5,9 @@ on:
       - main
 jobs:
   autoupdate:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     name: autoupdate
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: docker://chinthakagodawita/autoupdate-action:v1
         env:

.github/workflows/codeql.yml

@@ -2,17 +2,19 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: main
+    branches:
+      - main
   pull_request:
-    branches: main
+    branches:
+      - main
     paths:
       - '**/*.js'
       - '.github/workflows/codeql.yml'
 
 jobs:
   build:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
       - uses: github/codeql-action/init@v1

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

@@ -21,8 +21,10 @@ jobs:
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - name: npm ci
+      - name: Install dependencies
         run: npm ci
+      - name: Run build scripts
+        run: npm run build
       - name: (Dry run) sync indices
         env:
           ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}

.github/workflows/pa11y.yml

@@ -5,6 +5,7 @@ on:
     - cron: '25 17 * * *' # once a day at 17:25 UTC / 11:50 PST
 jobs:
   test:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     steps:
       - name: Check out repo

.github/workflows/repo-freeze-check.yml

@@ -16,6 +16,7 @@ env:
 
 jobs:
   check-freezer:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     name: Prevent merging during deployment freezes
     runs-on: ubuntu-latest
     steps:

.github/workflows/repo-sync-stalls.yml

@@ -16,7 +16,8 @@ jobs:
   repo-sync-stalls:
     runs-on: ubuntu-latest
     steps:
-      - name: Check if repo sync is stalled
+      - if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
+        name: Check if repo sync is stalled
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
           github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
@@ -36,6 +37,13 @@ jobs:
               return
             }
 
+            // Remove all pull requests that don't have the 
+            // 'automated-reposync-pr' label
+            pulls.data = pulls.data.filter(pr =>
+              pr.labels.some(label => label.name === 'automated-reposync-pr')
+            )
+
+            // Search for pull requests that have been open too long
             pulls.data.forEach(pr => {
               const timeDelta = Date.now() - Date.parse(pr.created_at);
               const minutesOpen = timeDelta / 1000 / 60;
@@ -51,4 +59,4 @@ jobs:
           channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
           bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
           color: failure
-          text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+repo+sync
+          text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+label%3Aautomated-reposync-pr

.github/workflows/repo-sync.yml

@@ -26,6 +26,7 @@ jobs:
           exit 1 # prevents further steps from running
 
   repo-sync:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     name: Repo Sync
     needs: check-freezer
     runs-on: ubuntu-latest
@@ -57,12 +58,13 @@ jobs:
           github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
 
       - name: Find pull request
-        uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b
+        uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9
         id: find-pull-request
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           branch: repo-sync
           base: main
+          author: Octomerger
 
       - name: Approve pull request
         if: ${{ steps.find-pull-request.outputs.number }}

.github/workflows/site-policy-sync.yml

@@ -0,0 +1,42 @@
+name: site-policy-sync
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow pull requests merged to the main branch
+  pull_request:
+    branches:
+      - main
+    types:
+      - closed
+    paths:
+      - 'content/github/site-policy/**'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  copy-file:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+
+      # Pushes to other repo
+      - name: Push folder to another repository
+        uses: crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_SITEPOLICY }}
+        with:
+          source_folder: 'content/github/site-policy'
+          destination_repo: 'github/site-policy'
+          destination_branch: 'repo-sync'
+          destination_folder: 'Policies'
+          user_email: 'pcihon@users.noreply.github.com'
+          user_name: 'pcihon'
+          commit_msg: 'Automatic sync from GitHub Docs.'

.github/workflows/start-new-engineering-pr-workflow.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   triage:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     continue-on-error: true
     env:

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

@@ -24,8 +24,10 @@ jobs:
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
-      - name: npm ci
+      - name: Install dependencies
         run: npm ci
+      - name: Run build scripts
+        run: npm run build
       - name: sync indices
         env:
           ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}

.github/workflows/test-windows.yml

@@ -4,12 +4,14 @@ name: Node.js Tests - Windows
 
 on:
   workflow_dispatch:
+  pull_request:
   schedule:
     - cron: '50 19 * * *' # once a day at 19:50 UTC / 11:50 PST
 
 jobs:
   test:
     runs-on: windows-latest
+    if: (github.event_name != 'pull_request') || (github.event_name == 'pull_request' && (contains(github.event.pull_request.labels.*.name, 'Windows') || contains(github.event.pull_request.labels.*.name, 'windows')))
     strategy:
       fail-fast: false
       matrix:

.github/workflows/translations.yml

@@ -17,11 +17,13 @@ jobs:
           echo 'The repo is currently frozen! Exiting this workflow.'
           exit 1 # prevents further steps from running
       - name: Find original Pull Request
-        uses: juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b
+        uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9
         id: pr
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           branch: translations
+          base: main
+          author: octoglot
       - if: ${{ steps.pr.outputs.number }}
         name: Check if already labeled
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9

.github/workflows/triage-unallowed-contributions.yml

@@ -104,6 +104,8 @@ jobs:
               body: reviewMessage,
               event: 'REQUEST_CHANGES'
             })
+
+            core.setFailed("It looks like you've modified some files we don't accept contributions for. Please see the review with requested changes for details.")
       # When the most recent review was CHANGES_REQUESTED and the existing
       # PR no longer contains unallowed changes, dismiss the previous review
       - name: Dismiss pull request review

.github/workflows/workflow-lint.yml

@@ -0,0 +1,22 @@
+name: Lint workflows
+
+on:
+  workflow_dispatch:
+  # push:
+  #   branches:
+  #     - main
+  # pull_request:
+  #   branches-ignore:
+  #     - translations
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+
+      - name: Run linter
+        uses: cschleiden/actions-linter@43fd4e08e52ed40c0e2782dc2425694388851576
+        with:
+          workflows: '[".github/workflows/*.yml"]'

.gitignore

@@ -1,4 +1,5 @@
 .algolia-cache
+.search-cache
 .DS_Store
 .env
 /node_modules/

Procfile

@@ -1 +1,3 @@
 web: NODE_ENV=production node server.js
+
+release: NODE_ENV=production node script/purge-redis-pages.js

README.md

@@ -18,7 +18,7 @@ We accept a lot of [different contributions](CONTRIBUTING.md/#types-of-contribut
 
 #### Click **make a contribution** from docs
 
-As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on **make a contribution** to navigate directly to that article in the codebase, so that you can begin making your contribution.
+As you're using GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on **make a contribution** to navigate directly to that article in the codebase, so that you can begin making your contribution.
 
 <img src="./assets/images/contribution_cta.png" width="400">