Merge branch 'main' into hotfix/transfer-repository

Author: janiceilene

.github/ISSUE_COMMENT_TEMPLATE/quick-status.yml

@@ -14,6 +14,8 @@ body:
           value: 'Status: YELLOW'
         - label: "RED \U0001F534 (BLOCKED)"
           value: 'Status: RED'
+        - label: "BLACK ⚫️ (We shipped it \U0001F389)"
+          value: 'Status: BLACK'
   - type: textarea
     attributes:
       label: Update Summary

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

@@ -34,19 +34,21 @@
     ```
     ☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version to Algolia. This will make the GHES content searchable on staging throughout content creation, and will ensure the search updates go live at the same time the content is published. See [`contributing/search.md`](https://github.com/github/docs-internal/blob/main/contributing/search.md) for details.
 
-- [ ] Create an OpenAPI topic branch
-
-  This branch is used to avoid propagating the OpenAPI dev mode check CI test failure in all of the branches. All changes that affect the OpenAPI schema should branch off of this topic branch. The tests should all be passing before the OpenAPI topic branch is merged into the megabranch.
-
-  For more information about how OpenAPI changes are published to docs.github.com, see [Publishing REST API changes to docs.github.com](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/publishing-documentation/publishing-REST-api-docs.md#publishing-rest-api-changes-to-docsgithubcom).
-
 - [ ] In `github/github`, to create a new GHES release follow these steps:
   - [ ] Copy the previous release's root document to a new root document for this release `cp app/api/description/ghes-<LATEST RELEASE NUMBER>.yaml app/api/description/ghes-<NEXT RELEASE NUMBER>.yaml`.
   - [ ] Update the `externalDocs.url` property in that file to use the new GHES release number.
   - [ ] Copy the previous release's configuration file to a new configuration file for this release `cp app/api/description/config/releases/ghes-<LATEST RELEASE NUMBER>.yaml app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml`.
   - [ ] Update the `variables.externalDocsUrl`, `variables.ghesVersion`, and `patch.[].value.url` in that file to use the new GHES release number.
   - [ ] Update `published` in that file to `false`. **Note:** This is important to ensure that 3.1 OpenAPI changes are not made public until 3.1 is released.
 
+#### Troubleshooting
+
+If the `OpenAPI dev mode check / check-schema-versions` check fails on the release branch, in your local checkout of the mega branch:
+
+- run `git checkout origin/main lib/rest/static/*`
+- run `script/rest/update-files.js --decorate-only`
+- push the resulting changes
+
 ### Before shipping the release branch
 
 - [ ] Add the GHES release notes to `data/release-notes/` and update the versioning frontmatter in `content/admin/release-notes.md` to `enterprise-server: '<=<RELEASE>'`

.github/allowed-actions.js

@@ -4,13 +4,13 @@
 // can be added it this list.
 
 module.exports = [
-  "actions/cache@0781355a23dac32fd3bac414512f4b903437991a", //actions/cache@v2.1.3
-  "actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f", //actions/checkout@v2.3.4
-  "actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9", //actions/script@v3.0.0
-  "actions/labeler@5f867a63be70efff62b767459b009290364495eb", //actions/labeler@v2.2.0
-  "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/setup-node@v2.1.4
-  "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/setup-ruby@vv1.64.1
-  "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16
+  "actions/cache@0781355a23dac32fd3bac414512f4b903437991a", // v2.1.3
+  "actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f", // v2.3.4
+  "actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9", // v3.0.0
+  "actions/labeler@5f867a63be70efff62b767459b009290364495eb", // v2.2.0
+  "actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", // v2.1.4
+  "ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", // v1.64.1
+  "actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", // v3.0.16
   "alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9",
   "andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84",
   "archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94",
@@ -23,11 +23,11 @@ module.exports = [
   "github/codeql-action/analyze@v1",
   "github/codeql-action/init@v1",
   "juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8",
-  "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9",
+  "juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51", // v1.5.0
   "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512",
   "lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8",
   "lee-dohm/no-response@9bb0a4b5e6a45046f00353d5de7d90fb8bd773bb",
-  "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0
+  "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", // v0.12.0
   "peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326",
   "peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd",
   "peter-evans/create-pull-request@8c603dbb04b917a9fc2dd991dc54fef54b640b43",

.github/workflows/copy-api-issue-to-internal.yml

@@ -0,0 +1,69 @@
+name: Copy to REST API issue to docs-content
+
+# **What it does**: Copies an issue in the open source repo to the docs-content repo, comments on and closes the original issue
+# **Why we have it**: REST API updates cannot be made in the open source repo. Instead, we copy the issue to an internal issue (we do not transfer so that the issue does not disappear for the contributor) and close the original issue.
+# **Who does it impact**: Open source and docs-content maintainers
+
+on:
+  issues:
+    types:
+      - labeled
+
+jobs:
+  transfer-issue:
+    name: Transfer issue
+    runs-on: ubuntu-latest
+    if: github.event.label.name == 'rest-description' && github.repository == 'github/docs'
+    steps:
+      - name: Check if this run was triggered by a member of the docs team
+        uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
+        id: triggered-by-member
+        with:
+          github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
+          result-encoding: string
+          script: |
+            const triggerer_login = context.payload.sender.login
+            const teamMembers = await github.request(
+              `/orgs/github/teams/docs/members?per_page=100`
+            )
+            const logins = teamMembers.data.map(member => member.login)
+            if (logins.includes(triggerer_login)) {
+              console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`)
+              return 'true'
+            }
+            console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`)
+            return 'false'
+
+      - name: Exit if not triggered by a docs team member
+        if: steps.triggered-by-member.outputs.result == 'false'
+        run: |
+          echo Aborting. This workflow must be triggered by a member of the docs team.
+          exit 1
+
+      - name: Create an issue in the docs-content repo
+        run: |
+          new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/docs-content)"
+          echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV
+        env:
+          GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
+          ISSUE_TITLE: ${{ github.event.issue.title }}
+          ISSUE_BODY: ${{ github.event.issue.body }}
+
+      - name: Comment on the new issue
+        run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE"
+        env:
+          GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
+          NEW_ISSUE: ${{ env.NEW_ISSUE }}
+          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 the REST API description must be made internally. I have copied your issue to an internal issue, so I will close this issue."
+        env:
+          GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
+          OLD_ISSUE: ${{ github.event.issue.html_url }}
+
+      - name: Close the old issue
+        run: gh issue close $OLD_ISSUE
+        env:
+          GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}}
+          OLD_ISSUE: ${{ github.event.issue.html_url }}

…orkflows/move-ready-to-merge-issues.yaml …ub/workflows/move-ready-to-merge-pr.yaml.github/workflows/move-ready-to-merge-issues.yaml renamed to .github/workflows/move-ready-to-merge-pr.yaml .github/workflows/move-ready-to-merge-issues.yaml renamed to .github/workflows/move-ready-to-merge-pr.yaml

@@ -1,7 +1,7 @@
-name: Move and unlabel ready to merge issues
+name: Move and unlabel ready to merge PRs
 
-# **What it does**: This moves ready to merge issues on the project board for the open source repo. When an issue in the open source repo is labeled "ready to merge," the "waiting for review" label is removed and the issue is moved to the "Triage" column.
-# **Why we have it**:  To help with managing our project boards.
+# **What it does**: When a PR in the open source repo is labeled "ready to merge," the "waiting for review" label is removed and the PR is moved to the "Triage" column.
+# **Why we have it**: To help with managing our project boards.
 # **Who does it impact**: Open source contributors, open-source maintainers.
 
 on:
@@ -14,7 +14,7 @@ jobs:
     if: github.repository == 'github/docs' && github.event.label.name == 'ready to merge'
     runs-on: ubuntu-latest
     steps:
-      - name: move issue
+      - name: move PR
         uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9
         with:
           project: Docs team reviews

.github/workflows/no-response.yaml

@@ -9,7 +9,7 @@ name: No Response
 
 on:
   issue_comment:
-    types: created
+    types: [created]
 
   schedule:
     # Schedule for five minutes after the hour every hour
@@ -27,4 +27,6 @@ jobs:
             to our request for more information from the original author. With only the
             information that is currently in the issue, we don't have enough information
             to take action. Please reach out if you have or find the answers we need so
-            that we can investigate further. See [this blog post on bug reports and the importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/) for more information about the kind of information that may be helpful.
+            that we can investigate further. See [this blog post on bug reports and the
+            importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/)
+            for more information about the kind of information that may be helpful.

.github/workflows/open-enterprise-issue.yml

@@ -1,5 +1,9 @@
 name: Open Enterprise release or deprecation issue
 
+# **What it does**: Checks if there is an Enterprise release or deprecation upcoming, and if so, opens an issue with the tasks to be completed.
+# **Why we have it**: GHES releases and deprecations run on a predictable schedule, so we can automate some of the project management aspects.
+# **Who does it impact**: Docs engineering, docs content.
+
 on:
   schedule:
     - cron: '49 14 * * *' # At 14:49 UTC daily

.github/workflows/repo-sync.yml

@@ -27,22 +27,23 @@ jobs:
     steps:
       - name: Find pull request
         if: ${{ github.repository == 'github/docs' }}
-        uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9
+        uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51
         id: find-pull-request
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.DOCS_BOT_SPAM_VISION }}
           branch: repo-sync
           base: main
+          state: open
 
       - name: Close pull request if unwanted
         if: ${{ github.repository == 'github/docs' && steps.find-pull-request.outputs.number }}
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
-          github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
+          github-token: ${{ secrets.DOCS_BOT_SPAM_VISION }}
           script: |
             const { owner, repo } = context.repo
 
-            const pr = await github.pulls.get({
+            const { data: pr } = await github.pulls.get({
               owner,
               repo,
               pull_number: parseInt(${{ steps.find-pull-request.outputs.number }})
@@ -115,17 +116,18 @@ jobs:
           destination_branch: main
           pr_title: 'repo sync'
           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: automerge,autoupdate,automated-reposync-pr
+          pr_label: autoupdate,automated-reposync-pr
           github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
 
       - name: Find pull request
-        uses: juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9
+        uses: juliangruber/find-pull-request-action@db875662766249c049b2dcd85293892d61cb0b51
         id: find-pull-request
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           branch: repo-sync
           base: main
           author: Octomerger
+          state: open
 
       - name: Approve pull request
         if: ${{ steps.find-pull-request.outputs.number }}
@@ -139,7 +141,7 @@ jobs:
         if: ${{ steps.find-pull-request.outputs.number }}
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
           script: |
             const mainHeadSha = await github.git.getRef({
               ...context.repo,
@@ -163,6 +165,41 @@ jobs:
               console.log(`Branch is already up-to-date`)
             }
 
+      - name: Enable GitHub auto-merge
+        if: ${{ steps.find-pull-request.outputs.number }}
+        uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
+        with:
+          github-token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
+          script: |
+            const pull = await github.pulls.get({
+              ...context.repo,
+              pull_number: parseInt(${{ steps.find-pull-request.outputs.number }})
+            })
+
+            const pullNodeId = pull.data.node_id
+            console.log(`Pull request GraphQL Node ID: ${pullNodeId}`)
+
+            const mutation = `mutation ($id: ID!) {
+              enablePullRequestAutoMerge(input: {
+                pullRequestId: $id,
+                mergeMethod: MERGE
+              }) {
+                clientMutationId
+              }
+            }`
+            const variables = {
+              id: pullNodeId
+            }
+
+            const graph = await github.graphql(mutation, variables)
+            console.log('GraphQL mutation result:\n' + JSON.stringify(graph))
+
+            if (graph.errors && graph.errors.length > 0) {
+              console.error('ERROR! Failed to enable auto-merge:\n - ' + graph.errors.map(error => error.message).join('\n - '))
+            } else {
+              console.log('Auto-merge enabled!')
+            }
+
       - name: Send Slack notification if workflow fails
         uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
         if: failure()

.github/workflows/send-crowdin-prs-to-boards.yml

@@ -1,5 +1,9 @@
 name: Send Crowdin PRs to boards
 
+# **What it does**: Sends PRs opened on the crowdin branch to the ready for work column in this board: https://github.com/orgs/github/projects/1269#column-13447153
+# **Why we have it**: To make sure the first responder sees crowdin translations that need to be merged as they review the Task board.
+# **Who does it impact**: Docs localization and Docs Engineering
+
 on:
   pull_request:
     types:
@@ -14,7 +18,7 @@ jobs:
         with:
           github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
           script: |
-            var squadBoardColumnId = 13447153; // Add to the team backlog/squad board
+            var squadBoardColumnId = 13447153; // Add to the team task board
 
             try {
               await github.projects.createCard({
@@ -25,14 +29,3 @@ jobs:
             } catch (error) {
               console.log(error);
             }
-
-            var prBoardColumnId = 10095775; // Add to the pull requests board
-            try {
-              await github.projects.createCard({
-                column_id: prBoardColumnId,
-                content_id: context.payload.pull_request.id,
-                content_type: "PullRequest"
-              });
-            } catch (error) {
-              console.log(error);
-            }

.github/workflows/send-issues-to-how-how-we-work-boards.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: true
     steps:
-      - if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic')
+      - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic')
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
           github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
@@ -31,7 +31,7 @@ jobs:
             } catch (error) {
               console.log(error);
             }
-      - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature')
+      - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature')
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
           github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
@@ -46,7 +46,7 @@ jobs:
             } catch (error) {
               console.log(error);
             }
-      - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic')
+      - if: (github.repository == 'github/docs-internal') && contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic')
         uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
         with:
           github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}