Merge branch 'main' into main

Author: Gabriel-Xu

.github/copilot-instructions.md

@@ -4,7 +4,7 @@ applyTo: "**"
 
 # Copilot instructions for docs.github.com
 
-This repository contains code to run the GitHub Docs site on docs.github.com, as well as the content that the site displays. We write the code in JavaScript and TypeScript, and we write the content primarily in Markdown.
+This repository powers the GitHub Docs site (docs.github.com). It contains both the Next.js application code (TypeScript) and the documentation content (Markdown).
 
 ## Creating a pull request
 
@@ -29,6 +29,8 @@ When you create a pull request:
 3. Label with "llm-generated". 
 4. If an issue exists, include "fixes owner/repo#issue" or "towards owner/repo#issue" as appropriate. 
 5. Always create PRs in **draft mode** using `--draft` flag.
+6. Do not commit directly to `main`.
+7. Whenever you create or comment on an issue or pull request, indicate you are GitHub Copilot.
 
 ## Accessing docs.github.com content programmatically
 

.github/instructions/all.instructions.md

@@ -11,13 +11,11 @@ For code reviews, follow guidelines, tests, and validate instructions. For creat
 - If available, use ripgrep (`rg`) instead of `grep`.
 - When using gh cli in double-quoted strings, escape backticks to prevent bash command substitution. In single-quoted strings, backticks do not need escaping.
 - All scripts should be listed in `package.json` and use `tsx`.
-- Whenever you create or comment on an issue or pull request, indicate you are GitHub Copilot.
 - Be careful fetching full HTML pages off the internet. Prefer to use MCP or gh cli whenever possible for github.com. Limit the number of tokens when grabbing HTML.
 - Avoid pull requests with over 300 lines of code changed. When significantly larger, offer to split up into smaller pull requests if possible.
 - All new code should be written in TypeScript and not JavaScript.
 - We use absolute imports, relative to the `src` directory, using the `@` symbol. For example, `getRedirect` which lives in `src/redirects/lib/get-redirect.ts` can be imported with `import getRedirect from '@/redirects/lib/get-redirect'`. The same rule applies for TypeScript (`.ts`) imports, e.g. `import type { GeneralSearchHit } from '@/search/types'`
 - For updates to the content linter, read important information in `src/content-linter/README.md`.
-- Do not commit to `main` branch.
 - Do not use git force push, and avoid git rebase.
 
 ## Tests

.github/instructions/code.instructions.md

@@ -6,7 +6,7 @@ applyTo: "content/**,data/**,**/*.md"
 
 **When to use**: Any content editing, documentation writing, or Markdown file changes. This is a condensed version of the full style guide at `/content/contributing/style-guide-and-content-model/style-guide.md`. Use these rules for routine work. Only consult the full style guide if you encounter a style question not covered here.
 
-For Liquid variable usage, reusables, linking conventions, bullet-list formatting, and parenthetical dashes, see `content.instructions.md` (loaded automatically alongside this file).
+For Liquid variable usage, reusables, linking conventions, bullet-list markers, and parenthetical dashes, see `content.instructions.md` (loaded automatically alongside this file).
 
 ## Core principles
 
@@ -52,15 +52,13 @@ For Liquid variable usage, reusables, linking conventions, bullet-list formattin
 
 ## Links
 
-* Use `[AUTOTITLE](/path/to/article)` for all internal links. Never hardcode article titles in link text.
 * Introduce links with "For more information, see" or "See" when context is clear.
 * Do not use inline links where words within a sentence are hyperlinked without additional context.
 * Do not include punctuation inside a hyperlink.
 * Do not repeat the same link more than once in the same article.
 
 ## Lists
 
-* Use `*` (asterisks) for unordered lists, never `-` (hyphens).
 * Capitalize the first letter of each list item.
 * Use periods only if the item is a complete sentence.
 * Introduce lists with a descriptive sentence, not vague phrases like "the following" in isolation.
@@ -83,9 +81,8 @@ For Liquid variable usage, reusables, linking conventions, bullet-list formattin
 * Use full words for Apple modifier keys (`Command`, `Option`, `Control`), not symbols.
 * Capitalize letter keys.
 
-## Product names and variables
+## Product names
 
-* Always use Liquid variables for product names—never hardcode them. Check `data/variables/product.yml` and `data/variables/copilot.yml`.
 * Product names are always singular (for example, "GitHub Actions helps" not "help").
 
 ## Word choice

.github/instructions/style-guide-summary.instructions.md

@@ -134,27 +134,28 @@ jobs:
               return
             }
 
-            const tableRows = redirectGroups.map(g => {
+            const directives = redirectGroups.map(g => {
               const occ = g.occurrences[0]
               const redirectTarget = occ?.redirectTarget ?? 'unknown'
               const file = occ?.file ?? 'unknown'
-              const lines = (occ?.lines ?? []).join(', ')
-              return `| \`${g.target}\` | \`${redirectTarget}\` | \`${file}\` | ${lines} |`
+              const lines = (occ?.lines ?? []).join(', ') || 'unknown'
+              return `- Update \`${g.target}\` to \`${redirectTarget}\` in \`${file}\` (line(s): ${lines})`
             }).join('\n')
 
             const artifactsUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/artifacts`
 
             const bodyLines = [
-              'Copilot please fix the redirected internal links listed in the table below. All changes should be made within the `github/docs-internal` repository. For each entry, open the source file and replace the **Current Link** with the **Update To** path.',
+              'Copilot, fix the redirected internal links listed below. All changes should be made within the `github/docs-internal` repository.',
+              '',
+              'For each directive below, open the specified file and find the old link path. Replace it with the new link path exactly as shown. Do not invent or guess link paths — only use the exact paths provided in each directive.',
+              '',
               'When all changes are made, open a pull request in `github/docs-internal` with the fixes. The pull request description should reference this issue to create a link between them. When the pull request is open, leave a comment on this issue with a link to it.',
               '',
               `These are the first ${redirectGroups.length} of ${allRedirectGroups.length} redirects found.`,
               '',
-              '## Redirects to fix',
+              '## Redirects to update',
               '',
-              '| Current Link | Update To | File | Line(s) |',
-              '|---|---|---|---|',
-              tableRows,
+              directives,
             ]
 
             const MAX_ISSUE_BODY_LENGTH = 65536
@@ -179,7 +180,7 @@ jobs:
               agent_assignment: {
                 target_repo: 'github/docs-internal',
                 base_branch: 'main',
-                custom_instructions: 'For each entry in the table, open the source file in the github/docs-internal repository and replace the Current Link with the Update To path. When all changes are made, open a pull request in github/docs-internal with the fixes. When the pull request is open, leave a comment on this issue with a link to it.',
+                custom_instructions: 'Follow each directive in the issue exactly. Each directive specifies a file, the old link to find, and the new link to replace it with. Use only the exact paths provided — do not invent or guess any link paths. When all changes are made, open a pull request in github/docs-internal with the fixes. When the pull request is open, leave a comment on this issue with a link to it.',
               },
             })
 

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

@@ -1,6 +1,9 @@
 name: Notify about production deployment
 
-# **What it does**: Posts a comment on the PR whose merge got into production.
+# **What it does**: Posts a comment on every PR in the deploy that got into
+#                   production. The merge queue can batch several PRs into one
+#                   deploy, so it walks back from the deployed commit to find
+#                   all of them.
 # **Why we have it**: So that the PR author can be informed when their merged PR is in production.
 # **Who does it impact**: Writers
 
@@ -38,38 +41,12 @@ jobs:
       - name: Sleep a little to give Fastly Purge a chance
         run: sleep 30
 
-      - name: Find last PR
-        id: get-number
+      - name: Find PRs and post production comments
         timeout-minutes: 5
         env:
           GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
         run: npm run find-past-built-pr
 
-      - name: Find content directory changes comment
-        if: ${{ steps.get-number.outputs.number != '' }}
-        uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad
-        id: findComment
-        with:
-          issue-number: ${{ steps.get-number.outputs.number }}
-          comment-author: 'github-actions[bot]'
-          body-includes: '<!-- GONE_TO_PRODUCTION -->'
-
-      - name: Update comment
-        if: ${{ steps.get-number.outputs.number != '' }}
-        uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9
-        with:
-          comment-id: ${{ steps.findComment.outputs.comment-id }}
-          issue-number: ${{ steps.get-number.outputs.number }}
-          body: |
-            <!-- GONE_TO_PRODUCTION -->
-            🚀 **This pull request has gone into production!**
-
-            The SHA of https://docs.github.com/_build matches the merge commit in this PR.
-
-            If you don't see updates when expected, try adding a random query string to the URL like `?bla=1234` and see if that helps.
-            If that shows the expected content, it would indicate that the CDN is "overly caching" the page still. It will eventually update, but it can take a while.
-          edit-mode: replace
-
       - uses: ./.github/actions/slack-alert
         if: ${{ failure() }}
         with:

.github/workflows/notify-about-deployment.yml

@@ -37,61 +37,44 @@ jobs:
         run: |
           npm run sync-secret-scanning
 
-      - name: Create a pull request
+      - name: Create pull request
+        id: create-pull-request
+        uses: peter-evans/create-pull-request@98357b18bf14b5342f975ff684046ec3b2a07725 # pin @v8.0.0
         env:
-          # Needed for gh
-          GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
-        run: |
-          # If nothing to commit, exit now. It's fine.
-          changes=$(git diff --name-only | wc -l)
-          untracked=$(git status --untracked-files --short | wc -l)
-          if [[ $changes -eq 0 ]] && [[ $untracked -eq 0 ]]; then
-            echo "There are no changes to commit. Exiting..."
-            exit 0
-          fi
-
-          git config --global user.name "docs-bot"
-          git config --global user.email "77750099+docs-bot@users.noreply.github.com"
-
-          branchname=sync-secret-scanning-`date +%Y%m%d%H%M%S`
-
-          remotesha=$(git ls-remote --heads origin $branchname)
-          if [ -n "$remotesha" ]; then
-            # output is not empty, it means the remote branch exists
-            echo "Branch $branchname already exists in 'github/docs-internal'. Exiting..."
-            exit 0
-          fi
-
-          git checkout -b $branchname
-          git add .
-          git commit -m "Add updated secret scanning data"
-          git push origin $branchname
-
-          echo "Creating pull request..."
-          gh pr create \
-            --title "Sync secret scanning data" \
-            --body '👋 humans. This PR updates the secret scanning data with the latest changes from github/token-scanning-service.
+          # Disable pre-commit hooks; they don't play nicely here
+          HUSKY: '0'
+        with:
+          # need to use a token with repo and workflow scopes for this step
+          token: ${{ secrets.DOCS_BOT_PAT_BASE }}
+          commit-message: 'Add updated secret scanning data'
+          title: Sync secret scanning data
+          body: |
+            👋 humans. This PR updates the secret scanning data with the latest changes from github/token-scanning-service.
 
             If CI passes, this PR will be auto-merged. :green_heart:
 
-            If CI does not pass or other problems arise, contact #docs-engineering on Slack.' \
-            --repo github/docs-internal \
-            --label secret-scanning-pipeline,'skip FR board',workflow-generated \
-            --head=$branchname
+            If CI does not pass or other problems arise, contact #docs-engineering on Slack.
+
+            This automated PR was created by [this workflow](https://github.com/github/docs-internal/blob/main/.github/workflows/sync-secret-scanning.yml).
+          branch: sync-secret-scanning-data
+          labels: |
+            secret-scanning-pipeline
+            skip FR board
+            workflow-generated
 
-          # can't approve your own PR, approve with Actions
-          echo "Approving pull request..."
-          unset GITHUB_TOKEN
-          gh auth login --with-token <<< "${{ secrets.GITHUB_TOKEN }}"
-          gh pr review --approve
-          echo "Approved pull request"
+      - name: Enable GitHub auto-merge
+        if: ${{ steps.create-pull-request.outputs.pull-request-number }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
+          AUTOMERGE_PR_NUMBER: ${{ steps.create-pull-request.outputs.pull-request-number }}
+        run: npm run enable-automerge
 
-          # Actions can't merge the PR so back to docs-bot to merge
-          echo "Setting pull request to auto merge..."
-          unset GITHUB_TOKEN
-          gh auth login --with-token <<< "${{ secrets.DOCS_BOT_PAT_BASE }}"
-          gh pr merge --auto --merge
-          echo "Set pull request to auto merge"
+      - if: ${{ steps.create-pull-request.outputs.pull-request-number }}
+        name: Approve
+        uses: juliangruber/approve-pull-request-action@dcc4effb325c0b503408619918d56e40653dcc91
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          number: ${{ steps.create-pull-request.outputs.pull-request-number }}
 
       - uses: ./.github/actions/slack-alert
         if: ${{ failure() && github.event_name != 'workflow_dispatch' }}