Merge branch 'github:main' into main

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

@@ -17,7 +17,7 @@ body:
       label: Code of Conduct
       description: This project has a Code of Conduct that all participants are expected to understand and follow.
       options:
-        - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
+        - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)
           required: true
 
   - type: textarea

.github/ISSUE_TEMPLATE/partner-contributed-documentation.yml

@@ -20,7 +20,7 @@ body:
       label: Code of Conduct
       description: This project has a Code of Conduct that all participants are expected to understand and follow.
       options:
-        - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
+        - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)
           required: true
   - type: checkboxes
     attributes:

.github/actions/node-npm-setup/action.yml

@@ -17,7 +17,7 @@ runs:
         key: ${{ runner.os }}-node_modules-${{ hashFiles('package*.json') }}-${{ hashFiles('.github/actions/node-npm-setup/action.yml') }}
 
     - name: Setup Node.js
-      uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
       with:
         node-version-file: 'package.json'
         cache: npm

.github/branch_protection_settings/main.json

@@ -38,7 +38,8 @@
       "fixtures",
       "frame",
       "products",
-      "workflows"
+      "workflows",
+      "lint-code"
     ],
     "contexts_url": "https://api.github.com/repos/github/docs-internal/branches/main/protection/required_status_checks/contexts",
     "checks": [
@@ -79,7 +80,8 @@
       { "context": "fixtures", "app_id": 15368 },
       { "context": "frame", "app_id": 15368 },
       { "context": "products", "app_id": 15368 },
-      { "context": "workflows", "app_id": 15368 }
+      { "context": "workflows", "app_id": 15368 },
+      { "context": "lint-code", "app_id": 15368 }
     ]
   },
   "restrictions": {

.github/dependabot.yml

@@ -5,15 +5,13 @@ updates:
     schedule:
       interval: weekly
       day: tuesday
-    open-pull-requests-limit: 20 # default is 5
     ignore:
       # Because this is so dependent on the remote server we use
       - dependency-name: '@elastic/elasticsearch'
       # Because whatever we have needs to match what @primer/react also uses
       - dependency-name: 'styled-components'
       - dependency-name: '*'
-        update-types:
-          ['version-update:semver-patch', 'version-update:semver-minor']
+        update-types: ['version-update:semver-patch']
 
   - package-ecosystem: 'github-actions'
     directory: '/'

.github/workflows/all-documents.yml

@@ -0,0 +1,42 @@
+name: All documents script
+
+# **What it does**: Verifies that the all-documents script works.
+# **Why we have it**: Code quality and sustainability.
+# **Who does it impact**: docs-engineering
+
+on:
+  pull_request:
+    paths:
+      - 'src/content-render/scripts/all-documents/**'
+      - 'package*.json'
+      - .github/workflows/all-documents.yml
+
+permissions:
+  contents: read
+
+jobs:
+  all-documents-script:
+    if: github.repository == 'github/docs-internal'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - uses: ./.github/actions/node-npm-setup
+
+      - name: Run all-documents script
+        env:
+          NODE_ENV: production
+        run: |
+          echo "Help..."
+          npm run all-documents -- --help
+
+          echo ""
+          echo "Storing in a file (English only)"
+          npm run all-documents -- -o all-documents.json -l en
+
+          echo ""
+          echo "Look at the first 50 lines of the file..."
+          cat all-documents.json | jq | head -n 50
+
+          # We're essentially expecting it to not crash and fail.

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

@@ -192,7 +192,6 @@ jobs:
           rsync -rptovR ./user-code/content/./**/*.md ./content
           rsync -rptovR ./user-code/assets/./**/*.png ./assets
           rsync -rptovR ./user-code/data/./**/*.{yml,md} ./data
-          rsync -rptovR ./user-code/src/./**/*.{scss,ts,tsx} ./src
 
       - uses: ./.github/actions/warmup-remotejson-cache
         with:

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

@@ -59,7 +59,7 @@ jobs:
           persist-credentials: 'false'
 
       - name: Setup Node.js
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version-file: 'package.json'
           cache: npm

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

@@ -74,7 +74,7 @@ jobs:
           echo "DOCKER_IMAGE=${{ secrets.NONPROD_REGISTRY_SERVER }}/${{ env.IMAGE_REPO }}:${{ env.COMMIT_REF }}-${{ github.run_number }}-${{ github.run_attempt }}" >> $GITHUB_ENV
 
       - name: Setup Node.js
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version-file: 'package.json'
           cache: npm

.github/workflows/close-dangling-prs.yml

@@ -0,0 +1,40 @@
+name: Close dangling PRs
+
+# **What it does**: Searches for specific PRs that have been open for a certain number of days and closes them.
+# **Why we have it**: Tidying up so humans don't need to do it.
+# **Who does it impact**: docs-engineering
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '20 16 * * *' # Run every day at 16:20 UTC / 8:20 PST
+  pull_request:
+    paths:
+      - .github/workflows/close-dangling-prs.yml
+      - src/workflows/close-dangling-prs.ts
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  close-dangling-prs:
+    if: github.repository == 'github/docs-internal'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - uses: ./.github/actions/node-npm-setup
+
+      - name: Close dangling PRs
+        env:
+          GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }}
+          DRY_RUN: ${{ github.event_name == 'pull_request'}}
+        run: npm run close-dangling-prs
+
+      - uses: ./.github/actions/slack-alert
+        if: ${{ failure() && github.event_name == 'schedule' }}
+        with:
+          slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
+          slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

.github/workflows/codeowners-docs-engineering.yml

@@ -46,11 +46,12 @@ jobs:
 
       - name: Add Docs Engineering as a reviewer
         run: |
-          has_reviewer=$(
+          needs_review=$(
             gh pr view $PR --json reviews |
-            jq 'any(.reviews[]; select(length > 0))'
+            jq '.reviews |
+            length == 0 or all(.author.login == "${{github.event.pull_request.user.login}}")'
           )
-          if ! $has_reviewer
+          if $needs_review
           then
             gh pr edit $PR --add-reviewer github/docs-engineering
           fi

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

@@ -27,6 +27,7 @@ on:
       - synchronize
     paths:
       - 'content/**'
+      - 'data/reusables/**'
 
 permissions:
   contents: read
@@ -62,7 +63,7 @@ jobs:
           APP_URL: ${{ env.APP_URL }}
           BASE_SHA: ${{ github.event.pull_request.base.sha || inputs.BASE_SHA }}
           HEAD_SHA: ${{ github.event.pull_request.head.sha || inputs.HEAD_SHA }}
-        run: src/workflows/content-changes-table-comment.js
+        run: npm run content-changes-table-comment
 
       - name: Find content directory changes comment
         uses: peter-evans/find-comment@d5fe37641ad8451bdd80312415672ba26c86575e

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

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: Setup Node.js
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version-file: 'package.json'
           cache: npm

.github/workflows/dont-delete-features.yml

@@ -0,0 +1,65 @@
+name: Don't delete features
+
+# **What it does**:
+#   If the PR (against main) involves deletion of features, if any of
+#   them are deletions or renames, post a comment, and ultimately
+#   fail the check.
+# **Why we have it**:
+#    If you delete the reference to an image, the English content is fine
+#    because it no longer tries to use the feature that doesn't exist.
+#    But this is not the case for translations.
+# **Who does it impact**: Docs content.
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'data/features/**'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dont-delete-features:
+    # It's 'docs-bot' that creates those PR from "Delete orphaned features"
+    if: github.event.pull_request.user.login != 'docs-bot' && (github.repository == 'github/docs-internal' || github.repository == 'github/docs')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - uses: ./.github/actions/node-npm-setup
+
+      - name: Get comment markdown
+        id: comment
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npm run deleted-features-pr-comment
+
+      - name: Find possible previous comment
+        if: ${{ steps.comment.outputs.markdown != '' }}
+        uses: peter-evans/find-comment@d5fe37641ad8451bdd80312415672ba26c86575e
+        id: findComment
+        with:
+          issue-number: ${{ github.event.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '<!-- DELETED_FEATURES -->'
+
+      - name: Update comment
+        if: ${{ steps.comment.outputs.markdown != '' }}
+        uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043
+        with:
+          comment-id: ${{ steps.findComment.outputs.comment-id }}
+          issue-number: ${{ github.event.number }}
+          body: ${{ steps.comment.outputs.markdown }}
+          edit-mode: replace
+
+      - name: Ultimately fail the workflow for attention
+        if: ${{ steps.comment.outputs.markdown != '' }}
+        run: |
+          echo "More than 1 feature was deleted as part of this PR."
+          echo "See posted PR commented about how to get them back."
+          exit 1

.github/workflows/enterprise-dates.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Create pull request
         id: create-pull-request
-        uses: peter-evans/create-pull-request@b1ddad2c994a25fbc81a28b3ec0e368bb2021c50 # pin @v6.0.0
+        uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e # pin @v6.0.2
         env:
           # Disable pre-commit hooks; they don't play nicely here
           HUSKY: '0'

.github/workflows/headless-tests.yml

@@ -2,7 +2,7 @@ name: Headless Tests
 
 # **What it does**: This runs our browser tests to test things that depend
 #                   on client-side JavaScript.
-# **Why we have it**: Because most automated jest tests only test static
+# **Why we have it**: Because most automated vitest tests only test static
 #                     input and outputs.
 # **Who does it impact**: Docs engineering, open-source engineering contributors.
 

.github/workflows/index-autocomplete-elasticsearch.yml

@@ -0,0 +1,52 @@
+name: Index autocomplete Elasticsearch
+
+# **What it does**: Indexes autocomplete data into Elasticsearch.
+# **Why we have it**: So we can power the API for autocomplete.
+# **Who does it impact**: docs-engineering
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '20 16 * * *' # Run every day at 16:20 UTC / 8:20 PST
+  pull_request:
+    paths:
+      - .github/workflows/index-autocomplete-elasticsearch.yml
+      - 'src/search/scripts/index/**'
+      - 'package*.json'
+
+permissions:
+  contents: read
+
+jobs:
+  index-autocomplete-elasticsearch:
+    if: ${{ github.repository == 'github/docs-internal' }}
+    runs-on: ubuntu-20.04-xl
+    steps:
+      - name: Checkout
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - uses: ./.github/actions/node-npm-setup
+
+      - uses: ./.github/actions/setup-elasticsearch
+        if: ${{ github.event_name == 'pull_request' }}
+
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }}
+          repository: github/docs-internal-data
+          path: docs-internal-data
+
+      - name: Check that Elasticsearch is accessible
+        if: ${{ github.event_name == 'pull_request' }}
+        run: curl --fail --retry-connrefused --retry 5 -I http://localhost:9200
+
+      - name: Run indexing
+        env:
+          ELASTICSEARCH_URL: ${{ github.event_name == 'pull_request' && 'http://localhost:9200' || secrets.ELASTICSEARCH_URL }}
+        run: npm run index -- autocomplete docs-internal-data
+
+      - uses: ./.github/actions/slack-alert
+        if: ${{ failure() && github.event_name == 'schedule' }}
+        with:
+          slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
+          slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

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

@@ -43,6 +43,7 @@ jobs:
           SHOULD_COMMENT: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT != '' }}
           CHECK_EXTERNAL_LINKS: false
           CREATE_REPORT: false
+          CHECK_ANCHORS: true
           # Not strictly necessary bit it makes warmServer() a bit faster
           # because it only bothers with English to begin with, which
           # we're filtering on anyway once the list of all pages has

.github/workflows/lint-code.yml

@@ -6,20 +6,8 @@ name: Lint code
 
 on:
   workflow_dispatch:
+  merge_group:
   pull_request:
-    paths:
-      - '**.js'
-      - '**.mjs'
-      - '**.ts'
-      - '**.tsx'
-      - '**.yaml'
-      - '**.yml'
-      - '**.scss'
-      - .eslintrc.cjs
-      # In case something like eslint or tsc or prettier upgrades
-      - 'package-lock.json'
-      # In case one of the script definitions changed
-      - 'package.json'
 
 permissions:
   contents: read

.github/workflows/os-ready-for-review.yml

@@ -48,7 +48,7 @@ jobs:
           exit 1
 
       - name: Setup Node.js
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version-file: 'package.json'
           cache: npm