Merge branch 'main' into patch-1

Author: Sharra-writes

.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@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+      uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
       with:
         node-version-file: 'package.json'
         cache: npm

.github/instructions/code.instructions.md

@@ -16,6 +16,7 @@ For code reviews, follow guidelines, tests, and validate instructions. For creat
 - 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`.
 
 ## Tests
 

.github/workflows/auto-add-ready-for-doc-review.yml

@@ -0,0 +1,54 @@
+name: Auto-add ready-for-doc-review label
+
+# **What it does**: Automatically adds the "ready-for-doc-review" label to DIY docs PRs that contain content or data changes when they are opened in a non-draft state or converted from draft to ready for review.
+# **Why we have it**: To ensure DIY docs PRs are automatically added to the docs-content review board without requiring manual labeling.
+# **Who does it impact**: Contributors making content changes and docs-content reviewers.
+
+on:
+  pull_request:
+    types:
+      - opened
+      - ready_for_review
+    paths:
+      - 'content/**'
+      - 'data/**'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  add-review-label:
+    name: Add ready-for-doc-review label to DIY docs PRs
+    if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.actor != 'github-openapi-bot' && github.actor != 'docs-bot'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Check team membership
+        id: membership_check
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
+          script: |
+            try {
+              await github.rest.teams.getMembershipForUserInOrg({
+                org: 'github',
+                team_slug: 'docs',
+                username: context.payload.sender.login,
+              });
+              return true
+            } catch(err) {
+              console.log(err)
+              return false
+            }
+
+      - name: Add ready-for-doc-review label
+        if: steps.membership_check.outputs.result == 'false'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+        run: |
+          gh pr edit $PR_URL --add-label ready-for-doc-review

.github/workflows/feedback-prompt.yml

@@ -0,0 +1,64 @@
+name: Feedback prompt for non-Docs team contributors when a PR is closed
+
+on:
+  pull_request:
+    types: [closed]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  comment-on-pr:
+    # This workflow should only run on the 'github/docs-internal' repository because it posts a feedback request
+    # to non-Docs team contributors when their PR is merged into the main branch.
+    # The feedback request asks contributors to leave feedback on their contributing experience in Slack.
+    if: github.repository == 'github/docs-internal' && github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check if PR author is in docs-content team
+        id: check_team
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
+          script: |
+            try {
+              const pr = context.payload.pull_request;
+              await github.rest.teams.getMembershipForUserInOrg({
+                org: 'github',
+                team_slug: 'docs-content',
+                username: pr.user.login,
+              });
+              // Author is in the team. Do nothing!
+            } catch(err) {
+              // Author not in team
+              core.exportVariable('NON_DOCS_HUBBER', 'true');
+            }
+
+      - name: Post changelog instructions comment
+
+        if: env.NON_DOCS_HUBBER == 'true'
+
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
+          script: |
+            // Get PR author username
+            const pr = context.payload.pull_request;
+            const prAuthor = pr.user.login;
+
+            // Compose the comment body as a plain text message to post on the PR
+            const commentBody =
+              "👋 @" + prAuthor +
+              " - Please leave us feedback on your contributing experience! " +
+              "To do this, please go to `#docs-contributor-feedback` on Slack.";
+
+            // Post the comment
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: pr.number,
+              body: commentBody
+            });

.github/workflows/first-responder-v2-prs-collect.yml

@@ -1,7 +1,7 @@
-name: Add docs-internal PRs to the docs-content FR project v2
+name: Add maintenance PRs to the docs-content FR project v2
 
-# **What it does**: Adds docs-internal pull requests that were opened by people outside of the docs team to the docs-content FR project v2
-# **Why we have it**: So we don't lose track of new pull requests for docs-content to review
+# **What it does**: Adds docs-internal pull requests authored by docs-bot to the docs-content FR project v2
+# **Why we have it**: So we don't lose track of maintenance pull requests for docs-content to review
 # **Who does it impact**: Docs content
 
 on:
@@ -18,76 +18,34 @@ permissions:
 
 jobs:
   first-responder-triage-pr:
-    name: Add PR to FR project v2
-    if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.actor != 'dependabot[bot]' && github.event.pull_request.head.ref != 'repo-sync' && !contains(github.event.pull_request.labels.*.name, 'skip FR board')
+    name: Add maintenance PR to FR project v2
+    if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.event.pull_request.user.id == 77750099 && github.event.pull_request.head.ref != 'repo-sync' && !contains(github.event.pull_request.labels.*.name, 'skip FR board')
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
 
-      - name: Check if the event originated from a team member
-        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd
-        id: check-membership
-        with:
-          github-token: ${{secrets.DOCS_BOT_PAT_BASE}}
-          result-encoding: string
-          script: |
-            const repoName = context.payload.repository.name
-            const ownerName = context.payload.repository.owner.login
-            const prAuthor = context.payload.pull_request.user.login
-            const teamMembers = await github.request(
-              `/orgs/github/teams/docs/members?per_page=100`
-            )
-            const teamLogins = teamMembers.data.map(member => member.login)
-            if (teamLogins.some(login => login === prAuthor)) {
-              console.log(`This pull request was authored by a member of the github/docs team.`)
-              return 'true'
-            }
-            console.log(`This pull request was authored by an external contributor.`)
-            return 'false'
-
-      # Check if docs-bot authored the PR
-      # If yes, set Type field to "Maintenance"
-      # If no, set Type field to "External contributor PR"
-      - name: Check if docs-bot is PR author
-        env:
-          PR_AUTHOR_ID: ${{ github.event.pull_request.user.id }}
-        run: |
-          if [ $PR_AUTHOR_ID == 77750099 ]; then
-            echo "TYPE_FIELD_VALUE=3f142cf2" >> $GITHUB_ENV
-          else
-            echo "TYPE_FIELD_VALUE=bbd0922a" >> $GITHUB_ENV
-          fi
-
-      - name: Add the docs-content-fr label
-        if: ${{ steps.check-membership.outputs.result == 'false' }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          PR_URL: ${{ github.event.pull_request.html_url }}
-        run: |
-          gh pr edit $PR_URL --add-label docs-content-fr
-
       # Add to the FR project
-      # and set type to "Maintenance" or "External contributor PR"
+      # and set type to "Maintenance"
       # and set date to now
       - name: Triage to docs-content FR project
-        if: steps.check-membership.outputs.result == 'false'
         env:
           GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
           PR_URL: ${{ github.event.pull_request.html_url }}
           PROJECT_NUMBER: 11672
           PROJECT_ID: PVT_kwDNJr_OAGNkBg
           TYPE_FIELD_ID: PVTSSF_lADNJr_OAGNkBs4D-Nyn
           DATE_FIELD_ID: PVTF_lADNJr_OAGNkBs4D-N1h
+          TYPE_FIELD_VALUE: 3f142cf2
         run: |
           echo "Adding item to project..."
 
           ITEM_ID=$(gh project item-add $PROJECT_NUMBER --owner github --url $PR_URL --format json | jq .id)
 
           echo "Editing type..."
 
-          gh project item-edit --project-id $PROJECT_ID --id $ITEM_ID --field-id $TYPE_FIELD_ID --single-select-option-id ${{ env.TYPE_FIELD_VALUE }}
+          gh project item-edit --project-id $PROJECT_ID --id $ITEM_ID --field-id $TYPE_FIELD_ID --single-select-option-id $TYPE_FIELD_VALUE
 
           echo "Editing date..."
 

.github/workflows/hubber-contribution-help.yml

@@ -44,11 +44,23 @@ jobs:
       - name: Comment on the PR
         if: steps.membership_check.outputs.result == 'false'
         run: |
-          gh pr comment $PR --body "### Next: add the review label
+          gh pr comment $PR --body "## Requesting a review from the Docs team
 
-          **🛎️ Is this PR ready for review?** A PR is ready for a docs review _after_ the self-review checklist is complete.
+          ### 🚧 Draft PRs
 
-           When this is ready for review, add the **\`ready-for-doc-review\`** label to this PR. The PR will then be automatically added to the [Docs Content review board](https://github.com/orgs/github/projects/2936). _Please allow at least 3 working days for a review, and longer if this is a substantial change._"
+          To add the PR to the Docs Content review board, click **Ready for review** in the merge box.
+
+          ### 🚀 Non-draft PRs
+
+          The PR is **ready** and has automatically been added to the Docs Content review board. The docs team will review it as soon as possible.
+
+          ### Lead time for review
+
+          Please allow at least 3 business days for a Docs Content review.
+
+          ### Need help?
+
+          Reach out in [#docs-content](https://github-grid.enterprise.slack.com/archives/C0E9DK082) on Slack."
 
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}