Merge branch 'main' into openapi-update-e3d37e33f5d6f3db5d80d5d602d7772843d043867c57c3e0ed3dd0af80aeec77

Author: shati-patel

.github/workflows/check-for-spammy-issues.yml

@@ -0,0 +1,62 @@
+name: Check for Spammy Issues
+on:
+  issues:
+    types: [opened]
+jobs:
+  spammy-title-check:
+    name: Remove issues with spammy titles
+    if: github.repository == 'github/docs'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
+        with:
+          github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
+          script: |
+
+            const issue = context.payload.issue
+            const owner = 'github'
+            const repo = 'docs'
+
+            const titleWordCount = issue.title.trim().split(' ').length
+            const titleWordCountMin = 2
+
+            try {
+              await github.teams.getMembershipForUserInOrg({
+                org: 'github',
+                team_slug: 'employees',
+                username: context.payload.sender.login,
+              });
+
+              // Do not perform this workflow with GitHub employees. This return
+              // statement only gets hit if the user is a GitHub employee
+              return
+            } catch(err) {
+              // An error will be thrown if the user is not a GitHub employee
+              // If a user is not a GitHub employee, we should check to see if title has at least the minimum required number of words in it and if it does, we can exit the workflow 
+
+              if(titleWordCount > titleWordCountMin) {
+                return
+              }
+            }
+
+            //
+            // Assuming the user is not a GitHub employee and the issue title
+            // has the minimum number of words required, proceed.
+            // 
+
+            // Close the issue and add the invalid label
+            await github.issues.update({
+              owner: owner,
+              repo: repo,
+              issue_number: issue.number,
+              labels: ['invalid'],
+              state: 'closed'
+            });
+
+            // Comment on the issue
+            await github.issues.createComment({
+              owner: owner,
+              repo: repo,
+              issue_number: issue.number,
+              body: "This issue appears to have been opened accidentally. I'm going to close it now, but feel free to open a new issue or ask any questions in [discussions](https://github.com/github/docs/discussions)!"
+            });

content/actions/guides/building-and-testing-java-with-gradle.md

@@ -113,6 +113,12 @@ steps:
         ${{ runner.os }}-gradle-
   - name: Build with Gradle
     run: ./gradlew build
+  - name: Cleanup Gradle Cache
+    # Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
+    # Restoring these files from a GitHub Actions cache might cause problems for future builds.
+    run: |
+      rm -f ~/.gradle/caches/modules-2/modules-2.lock
+      rm -f ~/.gradle/caches/modules-2/gc.properties
 ```
 {% endraw %}
 

content/developers/apps/creating-ci-tests-with-the-checks-api.md

@@ -435,7 +435,7 @@ The code above gets the full repository name and the head SHA of the commit from
 
 ### Step 2.3. Running RuboCop
 
-Great! You're cloning the repository and creating check runs using your CI server. Now you'll get into the nitty gritty details of the [RuboCop linter](https://rubocop.readthedocs.io/en/latest/basic_usage/#rubocop-as-a-code-style-checker) and [Checks API annotations](/rest/reference/checks#create-a-check-run).
+Great! You're cloning the repository and creating check runs using your CI server. Now you'll get into the nitty gritty details of the [RuboCop linter](https://docs.rubocop.org/rubocop/usage/basic_usage.html#code-style-checker) and [Checks API annotations](/rest/reference/checks#create-a-check-run).
 
 The following code runs RuboCop and saves the style code errors in JSON format. Add this code below the call to `clone_repository` you added in the [previous step](#step-22-cloning-the-repository) and above the code that updates the check run to complete.
 
@@ -447,7 +447,7 @@ logger.debug @report
 @output = JSON.parse @report
 ```
 
-The code above runs RuboCop on all files in the repository's directory. The option `--format json` is a handy way to save a copy of the linting results in a machine-parsable format. See the [RuboCop docs](https://rubocop.readthedocs.io/en/latest/formatters/#json-formatter) for details and an example of the JSON format.
+The code above runs RuboCop on all files in the repository's directory. The option `--format json` is a handy way to save a copy of the linting results in a machine-parsable format. See the [RuboCop docs](https://docs.rubocop.org/rubocop/formatters.html#json-formatter) for details and an example of the JSON format.
 
 Because this code stores the RuboCop results in a `@report` variable, it can safely remove the checkout of the repository. This code also parses the JSON so you can easily access the keys and values in your GitHub App using the `@output` variable.
 
@@ -588,7 +588,7 @@ This code limits the total number of annotations to 50. But you can modify this
 
 When the `offense_count` is zero, the CI test is a `success`. If there are errors, this code sets the conclusion to `neutral` in order to prevent strictly enforcing errors from code linters. But you can change the conclusion to `failure` if you would like to ensure that the check suite fails when there are linting errors.
 
-When errors are reported, the code above iterates through the `files` array in the RuboCop report. For each file, it extracts the file path and sets the annotation level to `notice`. You could go even further and set specific warning levels for each type of [RuboCop Cop](https://rubocop.readthedocs.io/en/latest/cops/), but to keep things simpler in this quickstart, all errors are set to a level of `notice`.
+When errors are reported, the code above iterates through the `files` array in the RuboCop report. For each file, it extracts the file path and sets the annotation level to `notice`. You could go even further and set specific warning levels for each type of [RuboCop Cop](https://docs.rubocop.org/rubocop/cops.html), but to keep things simpler in this quickstart, all errors are set to a level of `notice`.
 
 This code also iterates through each error in the `offenses` array and collects the location of the offense and error message. After extracting the information needed, the code creates an annotation for each error and stores it in the `annotations` array. Because annotations only support start and end columns on the same line, `start_column` and `end_column` are only added to the `annotation` object if the start and end line values are the same.
 
@@ -718,7 +718,7 @@ If the annotations are related to a file already included in the PR, the annotat
 
 If you've made it this far, kudos! 👏 You've already created a CI test. In this section, you'll add one more feature that uses RuboCop to automatically fix the errors it finds. You already added the "Fix this" button in the [previous section](#step-25-updating-the-check-run-with-ci-test-results). Now you'll add the code to handle the `requested_action` check run event triggered when someone clicks the "Fix this" button.
 
-The RuboCop tool [offers](https://rubocop.readthedocs.io/en/latest/basic_usage/#auto-correcting-offenses) the `--auto-correct` command-line option to automatically fix errors it finds. When you use the `--auto-correct` feature, the updates are applied to the local files on the server. You'll need to push the changes to GitHub after RuboCop does its magic.
+The RuboCop tool [offers](https://docs.rubocop.org/rubocop/usage/basic_usage.html#auto-correcting-offenses) the `--auto-correct` command-line option to automatically fix errors it finds. When you use the `--auto-correct` feature, the updates are applied to the local files on the server. You'll need to push the changes to GitHub after RuboCop does its magic.
 
 To push to a repository, your app must have write permissions for "Repository contents." You set that permission back in [Step 2.2. Cloning the repository](#step-22-cloning-the-repository) to **Read & write**, so you're all set.
 

content/github/getting-started-with-github/git-cheatsheet.md

@@ -7,6 +7,6 @@ versions:
   enterprise-server: '*'
   github-ae: '*'
 ---
-Learning all available Git commands at once can be a daunting task. Keep one of our [Git Cheat Sheets](https://services.github.com/on-demand/resources/cheatsheets/) nearby for reference. The Using Git Cheat Sheet is available in several languages. For more information, see the [resources page on the GitHub Services website](https://services.github.com/on-demand/resources/).
+Learning all available Git commands at once can be a daunting task. Our cheat sheets provide a quick reference for the commands you'll use most often: see "[Git Cheat Sheets](https://training.github.com/)." The "Using Git" cheat sheet is available in several languages. 
 
 In addition, take a look at our [Git and GitHub learning resources](/articles/git-and-github-learning-resources/) page that links to guides, videos and more.

data/release-notes/3-0/0-rc.yml data/release-notes/3-0/0-rc1.ymldata/release-notes/3-0/0-rc.yml renamed to data/release-notes/3-0/0-rc1.yml

@@ -47,10 +47,10 @@ <h2 class="border-bottom-0 m-0 p-0">
                     </h2>
 
                     {% if patch.release_candidate %}
-                      <span class="IssueLabel bg-orange text-white ml-3">Release Candidate</span>
+                      <span class="IssueLabel bg-orange text-white ml-3" style="white-space: pre">Release Candidate</span>
                     {% endif %}
 
-                    <a href="https://enterprise.github.com/releases/{{ patch.version | replace: '-rc', '' }}/download" class="ml-3 text-small text-bold">
+                    <a href="https://enterprise.github.com/releases/{{ patch.downloadVersion }}/download" class="ml-3 text-small text-bold">
                       Download
                     </a>
 

layouts/release-notes.html

@@ -0,0 +1,19 @@
+const path = require('path')
+const statsd = require('./statsd')
+
+module.exports = function instrumentMiddleware (relativePath) {
+  // Requires the file as if it were being required from '../middleware/index.js'.
+  // This is a little wonky, but let's us write `app.use(instrument(path))` and
+  // maintain the name of the file, instead of hard-coding it for each middleware.
+  const middleware = require(path.resolve(__dirname, '../middleware', relativePath))
+
+  // Check if the middleware is an async function, to use the appropriate timer
+  const isAsyncFunction = middleware.constructor.name === 'AsyncFunction'
+
+  // Add a tag so we can see all middleware together
+  const tags = { middleware: path.basename(relativePath) }
+
+  return isAsyncFunction
+    ? statsd.asyncTimer(middleware, 'middleware', tags)
+    : statsd.timer(middleware, 'middleware', tags)
+}

lib/instrument-middleware.js

@@ -9,7 +9,15 @@ const enterpriseReleases = require('../../lib/enterprise-server-releases').suppo
  */
 function sortPatchKeys (release, version) {
   const keys = Object.keys(release)
-    .map(key => ({ version: `${version}.${key}`, patchVersion: key, ...release[key] }))
+    .map(key => {
+      const keyWithDots = key.replace(/-/g, '.')
+      return {
+        version: `${version}.${keyWithDots}`,
+        patchVersion: keyWithDots,
+        downloadVersion: `${version}.${keyWithDots.replace(/\.rc\d*$/, '')}`,
+        ...release[key]
+      }
+    })
   return keys
     .sort((a, b) => {
       if (semver.gt(a.version, b.version)) return -1

middleware/contextualizers/enterprise-release-notes.js

@@ -1,4 +1,5 @@
 const express = require('express')
+const instrument = require('../lib/instrument-middleware')
 
 const isDevelopment = process.env.NODE_ENV === 'development'
 
@@ -24,7 +25,7 @@ module.exports = function (app) {
   // See https://expressjs.com/en/guide/behind-proxies.html
   app.set('trust proxy', 1)
   app.use(require('./rate-limit'))
-  app.use(require('./handle-invalid-paths'))
+  app.use(instrument('./handle-invalid-paths'))
 
   // *** Security ***
   app.use(require('./cors'))
@@ -43,50 +44,50 @@ module.exports = function (app) {
   // *** Config and context for redirects ***
   app.use(require('./req-utils')) // Must come before record-redirect and events
   app.use(require('./record-redirect'))
-  app.use(require('./detect-language')) // Must come before context, breadcrumbs, find-page, handle-errors, homepages
-  app.use(asyncMiddleware(require('./context'))) // Must come before early-access-*, handle-redirects
+  app.use(instrument('./detect-language')) // Must come before context, breadcrumbs, find-page, handle-errors, homepages
+  app.use(asyncMiddleware(instrument('./context'))) // Must come before early-access-*, handle-redirects
 
   // *** Redirects, 3xx responses ***
   // I ordered these by use frequency
   app.use(require('connect-slashes')(false))
-  app.use(require('./redirects/external'))
-  app.use(require('./redirects/help-to-docs'))
-  app.use(require('./redirects/language-code-redirects')) // Must come before contextualizers
-  app.use(require('./redirects/handle-redirects')) // Must come before contextualizers
+  app.use(instrument('./redirects/external'))
+  app.use(instrument('./redirects/help-to-docs'))
+  app.use(instrument('./redirects/language-code-redirects')) // Must come before contextualizers
+  app.use(instrument('./redirects/handle-redirects')) // Must come before contextualizers
 
   // *** Config and context for rendering ***
-  app.use(require('./find-page')) // Must come before archived-enterprise-versions, breadcrumbs, featured-links, products, render-page
-  app.use(require('./block-robots'))
+  app.use(instrument('./find-page')) // Must come before archived-enterprise-versions, breadcrumbs, featured-links, products, render-page
+  app.use(instrument('./block-robots'))
 
   // *** Rendering, 2xx responses ***
   // I largely ordered these by use frequency
-  app.use(require('./archived-enterprise-versions-assets')) // Must come before static/assets
+  app.use(instrument('./archived-enterprise-versions-assets')) // Must come before static/assets
   app.use('/dist', express.static('dist'))
   app.use('/assets', express.static('assets'))
   app.use('/public', express.static('data/graphql'))
-  app.use('/events', require('./events'))
-  app.use('/csrf', require('./csrf-route'))
-  app.use('/search', require('./search'))
-  app.use(require('./archived-enterprise-versions'))
-  app.use(require('./robots'))
-  app.use(/(\/.*)?\/early-access$/, require('./contextualizers/early-access-links'))
-  app.use(require('./categories-for-support-team'))
-  app.use(require('./loaderio-verification'))
-  app.get('/_500', asyncMiddleware(require('./trigger-error')))
+  app.use('/events', instrument('./events'))
+  app.use('/csrf', instrument('./csrf-route'))
+  app.use('/search', instrument('./search'))
+  app.use(instrument('./archived-enterprise-versions'))
+  app.use(instrument('./robots'))
+  app.use(/(\/.*)?\/early-access$/, instrument('./contextualizers/early-access-links'))
+  app.use(instrument('./categories-for-support-team'))
+  app.use(instrument('./loaderio-verification'))
+  app.get('/_500', asyncMiddleware(instrument('./trigger-error')))
 
   // *** Preparation for render-page ***
-  app.use(asyncMiddleware(require('./contextualizers/enterprise-release-notes')))
-  app.use(require('./contextualizers/graphql'))
-  app.use(require('./contextualizers/rest'))
-  app.use(require('./contextualizers/webhooks'))
-  app.use(require('./breadcrumbs'))
-  app.use(require('./early-access-breadcrumbs'))
-  app.use(require('./enterprise-server-releases'))
-  app.use(require('./dev-toc'))
-  app.use(require('./featured-links'))
-  app.use(require('./learning-track'))
+  app.use(asyncMiddleware(instrument('./contextualizers/enterprise-release-notes')))
+  app.use(instrument('./contextualizers/graphql'))
+  app.use(instrument('./contextualizers/rest'))
+  app.use(instrument('./contextualizers/webhooks'))
+  app.use(instrument('./breadcrumbs'))
+  app.use(instrument('./early-access-breadcrumbs'))
+  app.use(instrument('./enterprise-server-releases'))
+  app.use(instrument('./dev-toc'))
+  app.use(instrument('./featured-links'))
+  app.use(instrument('./learning-track'))
 
   // *** Rendering, must go last ***
-  app.get('/*', asyncMiddleware(require('./render-page')))
+  app.get('/*', asyncMiddleware(instrument('./render-page')))
   app.use(require('./handle-errors'))
 }

middleware/index.js

@@ -161,7 +161,7 @@
     "test": "jest && eslint . && prettier -c \"**/*.{yml,yaml}\" && npm run check-deps",
     "prebrowser-test": "npm run build",
     "browser-test": "start-server-and-test browser-test-server 4001 browser-test-tests",
-    "browser-test-server": "cross-env NODE_ENV=production ENABLED_LANGUAGES='en,ja' PORT=4001 node server.js",
+    "browser-test-server": "cross-env NODE_ENV=production PORT=4001 node server.js",
     "browser-test-tests": "cross-env BROWSER=1 jest tests/browser/browser.js",
     "sync-search": "start-server-and-test sync-search-server 4002 sync-search-indices",
     "sync-search-dry-run": "DRY_RUN=1 npm run sync-search",