Merge branch 'main' into update-gcm-info

Author: vgrl

.github/actions-scripts/create-enterprise-issue.js

@@ -86,7 +86,9 @@ async function run() {
     'utf8'
   )
   const issueLabels =
-    milestone === 'release' ? ['enterprise release'] : ['enterprise deprecation', 'priority-4', 'batch', 'time sensitive']
+    milestone === 'release'
+      ? ['enterprise release']
+      : ['enterprise deprecation', 'priority-4', 'batch', 'time sensitive']
   const issueTitle = `[${nextMilestoneDate}] Enterprise Server ${versionNumber} ${milestone} (technical steps)`
 
   const issueBody = `GHES ${versionNumber} ${milestone} occurs on ${nextMilestoneDate}.

.github/actions-scripts/enable-automerge.js

@@ -1,11 +1,20 @@
 import { getOctokit } from '@actions/github'
-const token = process.env.GITHUB_TOKEN
-const prNumber = process.env.AUTOMERGE_PR_NUMBER
-const [org, repo] = process.env.GITHUB_REPOSITORY.split('/')
-const github = getOctokit(token)
 
 main()
 async function main() {
+  const [org, repo] = process.env.GITHUB_REPOSITORY.split('/')
+  if (!org || !repo) {
+    throw new Error('GITHUB_REPOSITORY environment variable not set')
+  }
+  const prNumber = process.env.AUTOMERGE_PR_NUMBER
+  if (!prNumber) {
+    throw new Error(`AUTOMERGE_PR_NUMBER environment variable not set`)
+  }
+  const token = process.env.GITHUB_TOKEN
+  if (!token) {
+    throw new Error(`GITHUB_TOKEN environment variable not set`)
+  }
+  const github = getOctokit(token)
   const pull = await github.rest.pulls.get({
     owner: org,
     repo: repo,

.github/actions-scripts/update-merge-queue-branch.js

@@ -20,10 +20,14 @@ const github = getOctokit(token)
 main()
 
 async function main() {
+  const [org, repo] = process.env.GITHUB_REPOSITORY.split('/')
+  if (!org || !repo) {
+    throw new Error('GITHUB_REPOSITORY environment variable not set')
+  }
   // Get a list of open PRs and order them from oldest to newest
-  const query = `query ($first: Int, $after: String, $firstLabels: Int) {
-    organization(login: "github") {
-      repository(name: "docs-internal") {
+  const query = `query ($first: Int, $after: String, $firstLabels: Int, $repo: String!, $org: String!) {
+    organization(login: $org) {
+      repository(name: $repo) {
         pullRequests(first: $first, after: $after, states: OPEN, orderBy: {field: UPDATED_AT, direction: ASC}) {
           edges{
             node {
@@ -55,6 +59,8 @@ async function main() {
   }`
 
   const queryVariables = {
+    repo,
+    org,
     first: 100,
     after: null, // when pagination in null it will get first page
     firstLabels: 100,
@@ -105,20 +111,25 @@ async function main() {
 
   // Get the list of prs with the skip label so they can
   // be put at the beginning of the list
-  const prioritizedPrList = autoMergeEnabledPRs
-    .filter((pr) => pr.labels.includes('skip-to-front-of-merge-queue'))
-    .concat(autoMergeEnabledPRs.filter((pr) => !pr.labels.includes('skip-to-front-of-merge-queue')))
+  const prioritizedPrList = autoMergeEnabledPRs.sort(
+    (a, b) =>
+      Number(b.labels.includes('skip-to-front-of-merge-queue')) -
+      Number(a.labels.includes('skip-to-front-of-merge-queue'))
+  )
 
-  const nextInQueue = prioritizedPrList.shift()
-  // Update the branch for the next PR in the merge queue
-  github.rest.pulls.updateBranch({
-    owner: 'github',
-    repo: 'docs-internal',
-    pull_number: parseInt(nextInQueue.number),
-  })
+  if (prioritizedPrList.length) {
+    const nextInQueue = prioritizedPrList.shift()
+    // Update the branch for the next PR in the merge queue
+    github.rest.pulls.updateBranch({
+      owner: org,
+      repo,
+      pull_number: nextInQueue.number,
+    })
+    console.log(`⏱ Total PRs in the merge queue: ${prioritizedPrList.length + 1}`)
+    console.log(`🚂 Updated branch for PR #${JSON.stringify(nextInQueue, null, 2)}`)
+  }
 
-  console.log(`⏱ Total PRs in the merge queue: ${prioritizedPrList.length + 1}`)
-  console.log(`🚂 Updated branch for PR #${JSON.stringify(nextInQueue, null, 2)}`)
-  console.log(`🚏 Next up in the queue: `)
-  console.log(JSON.stringify(prioritizedPrList, null, 2))
+  prioritizedPrList.length
+    ? console.log(`🚏 Next up in the queue: \n ${JSON.stringify(prioritizedPrList, null, 2)}`)
+    : console.log(`⚡ The merge queue is empty`)
 }

.github/workflows/autoupdate-branch.yml

@@ -30,6 +30,18 @@ jobs:
     name: autoupdate
     runs-on: ubuntu-latest
     steps:
+      - name: Check out repo content
+        uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97
+
+      - name: Setup Node
+        uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c
+        with:
+          node-version: 16.13.x
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
       - name: Update next PR in queue
         env:
           GITHUB_TOKEN: ${{ secrets.DOCUBOT_REPO_PAT }}

.github/workflows/create-translation-batch-pr.yml

@@ -128,7 +128,7 @@ jobs:
       - name: Check parsing
         run: |
           node script/i18n/lint-translation-files.js --check parsing
-          git add . && git commit -m "Run script/i18n/lint-translation-files.js --check parsin" || echo "Nothing to commit"
+          git add . && git commit -m "Run script/i18n/lint-translation-files.js --check parsing" || echo "Nothing to commit"
 
       # step 8b in docs-engineering/crowdin.md
       - name: Check rendering

.github/workflows/repo-sync.yml

@@ -128,6 +128,9 @@ jobs:
           pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!"
           pr_label: automated-reposync-pr
           github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
+          # This will exit 0 if there's no difference between `repo-sync`
+          # and `main`. And if so, no PR will be created.
+          pr_allow_empty: false
 
       - name: Find pull request
         uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51

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

@@ -19,9 +19,7 @@ on:
 jobs:
   sync:
     name: Get the latest docs
-    if: >-
-      github.event.pull_request.merged == true &&
-      github.repository == 'github/docs-internal'
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && github.repository == 'github/docs-internal')
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -49,6 +47,7 @@ jobs:
           git checkout -b automated-sync-$GITHUB_RUN_ID
           git add .
           PR_TITLE=${{ github.event.pull_request.title }}
+          echo PR_TITLE: $PR_TITLE
           [[ ! -z $PR_TITLE ]] && DESCRIPTION="${PR_TITLE}" || DESCRIPTION="Update manually triggered by workflow"
           echo "DESCRIPTION=$DESCRIPTION" >> $GITHUB_ENV
           git commit -m "$(echo $DESCRIPTION)"

.github/workflows/staging-build-pr.yml

@@ -34,9 +34,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Dump full context for debugging
-        env:
-          GITHUB_CONTEXT: ${{ toJSON(github) }}
-        run: echo "$GITHUB_CONTEXT"
+        run: |
+          cat << EOF
+          ${{ toJSON(github) }}
+          EOF
 
   build-pr:
     if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }}

.github/workflows/transfer-to-localization-repo.yml

@@ -60,7 +60,7 @@ jobs:
           OLD_ISSUE: ${{ github.event.issue.html_url }}
 
       - name: Comment on the old issue
-        run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Updates to translated content must be made internally. I have copied your issue to an internal issue, so I will close this issue."
+        run: gh issue comment $OLD_ISSUE --body "Thanks for opening this issue! Unfortunately, we are not able to accept issues for translated content. Our translation process involves an integration with an external service at crowdin.com, where all translation activity happens. We hope to eventually open up the translation process to the open-source community, but we're not there yet.See https://github.com/github/docs/blob/main/contributing/types-of-contributions.md#earth_asia-translations for more information."
         env:
           GITHUB_TOKEN: ${{secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES}}
           OLD_ISSUE: ${{ github.event.issue.html_url }}

README.md

@@ -33,7 +33,7 @@ That's how you can easily become a member of the GitHub Documentation community.
 ## READMEs
 
 In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:
-YOu can go through among them for specified details regarding the topics listed below.
+You can go through among them for specified details regarding the topics listed below.
 
 - [content/README.md](content/README.md)
 - [content/graphql/README.md](content/graphql/README.md)