Merge branch 'main' into patch-1

Author: sophietheking

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

@@ -64,12 +64,12 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng
 
   ☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version. 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.
 - [ ] Get the megabranch green with passing tests as soon as possible. This typically involves fixing broken links and working with engineering to address other unexpected test failures.
-- [ ] In `github/github`, to create a new GHES release follow these steps (some of these steps may have already been done):
-  - [ ] 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.
+- [ ] In `github/github`, use a Codespace to create a pull request that adds a new GHES release. Follow these steps (some of these steps may have already been done):
   - [ ] 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 all references to the old GHES release number in that file  to use the new GHES release number. There are about 4 occurrences at the time of this writing:  `variables.externalDocsUrl`, `variables.ghesVersion`, and two keys under `patch` for the paths `/info/x-github-release` and `/externalDocs`.
   - [ ] Update `published` in that file to `false`. **Note:** This is important to ensure that changes for the next version of the OpenAPI schema changes are not made public until the new version is released.
+  - [ ] Run `./bin/openapi generate-root-files` to generate the `app/api/description/ghes-<LATEST RELEASE NUMBER>.yaml` file and merge the changes.
+  - [ ] Create a PR with the two file changes `app/api/description/ghes-<NEW RELEASE NUMBER>.yaml` and `app/api/description/config/releases/ghes-<NEW RELEASE NUMBER>.yaml`
   - [ ] Create a second PR based on the PR created ☝️ that toggles `published` to `true` in the `app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml` file. When this PR merges it will publish the new release to the `github/rest-api-description` repo and will trigger a pull request in the `github/docs-internal` repo with the schemas for the next GHES release. There is a step in this list to merge that PR in the "Before shipping the release branch" section.
 - [ ] At least once a day until release, merge `main` into the megabranch and resolve any conflicts or failing tests.
 

.github/actions/lib/get-env-inputs.js

@@ -16,3 +16,22 @@ export function getEnvInputs(options) {
     })
   )
 }
+
+/*
+ * Given an environment variable key, return `true` or `false` if the
+ * value is recognizable.
+ * Turn 'true' or '1' into `true`. And '', '0', or 'false' into `false`.
+ * All other values are invalid.
+ * Now you can't accidentally set `export FOO=falsee` which as string `'falsee'`
+ * could have been interpreted as a truthy value.
+ *
+ * @param {string} key - name of the environment variable
+ *
+ * @returns {boolean}
+ */
+export function boolEnvVar(key) {
+  const value = process.env[key] || ''
+  if (value === '' || value === 'false' || value === '0') return false
+  if (value === 'true' || value === '1') return true
+  throw new Error(`Invalid value for set environment variable ${key}: '${value}'`)
+}

.github/actions/rendered-content-link-checker.js

@@ -14,7 +14,7 @@ import warmServer from '../../lib/warm-server.js'
 import renderContent from '../../lib/render-content/index.js'
 import { deprecated } from '../../lib/enterprise-server-releases.js'
 import excludedLinks from '../../lib/excluded-links.js'
-import { getEnvInputs } from './lib/get-env-inputs.js'
+import { getEnvInputs, boolEnvVar } from './lib/get-env-inputs.js'
 import { debugTimeEnd, debugTimeStart } from './lib/debug-time-taken.js'
 import { uploadArtifact as uploadArtifactLib } from './lib/upload-artifact.js'
 import github from '../../script/helpers/github.js'
@@ -51,23 +51,9 @@ const deprecatedVersionPrefixesRegex = new RegExp(
 
 // When this file is invoked directly from action as opposed to being imported
 if (import.meta.url.endsWith(process.argv[1])) {
-  // Validate that required action inputs are present
-  getEnvInputs(['GITHUB_TOKEN'])
-
   // Optional env vars
-  const {
-    ACTION_RUN_URL,
-    CREATE_REPORT,
-    CHECK_EXTERNAL_LINKS,
-    LEVEL,
-    SHOULD_COMMENT,
-    COMMENT_LIMIT_TO_EXTERNAL_LINKS,
-    FAIL_ON_FLAW,
-    FILES_CHANGED,
-    REPORT_REPOSITORY,
-    REPORT_AUTHOR,
-    REPORT_LABEL,
-  } = process.env
+  const { ACTION_RUN_URL, LEVEL, FILES_CHANGED, REPORT_REPOSITORY, REPORT_AUTHOR, REPORT_LABEL } =
+    process.env
 
   const octokit = github()
 
@@ -89,21 +75,27 @@ if (import.meta.url.endsWith(process.argv[1])) {
     verbose: true,
     linkReports: true,
     checkImages: true,
-    patient: true,
+    patient: boolEnvVar('PATIENT'),
     random: false,
     language: 'en',
     actionUrl: ACTION_RUN_URL,
-    checkExternalLinks: CHECK_EXTERNAL_LINKS === 'true',
-    shouldComment: SHOULD_COMMENT === 'true',
-    commentLimitToExternalLinks: COMMENT_LIMIT_TO_EXTERNAL_LINKS === 'true',
-    failOnFlaw: FAIL_ON_FLAW === 'true',
-    createReport: CREATE_REPORT === 'true',
+    checkExternalLinks: boolEnvVar('CHECK_EXTERNAL_LINKS'),
+    shouldComment: boolEnvVar('SHOULD_COMMENT'),
+    commentLimitToExternalLinks: boolEnvVar('COMMENT_LIMIT_TO_EXTERNAL_LINKS'),
+    failOnFlaw: boolEnvVar('FAIL_ON_FLAW'),
+    createReport: boolEnvVar('CREATE_REPORT'),
     reportRepository: REPORT_REPOSITORY,
     reportLabel: REPORT_LABEL,
     reportAuthor: REPORT_AUTHOR,
     actionContext: getActionContext(),
   }
 
+  if (opts.shouldComment || opts.createReport) {
+    // `GITHUB_TOKEN` is optional. If you need the token to post a comment
+    // or open an issue report, you might get cryptic error messages from Octokit.
+    getEnvInputs(['GITHUB_TOKEN'])
+  }
+
   main(coreLib, octokit, uploadArtifactLib, opts, {})
 }
 
@@ -137,6 +129,7 @@ if (import.meta.url.endsWith(process.argv[1])) {
  *  verbose {boolean} - Set to true for more verbose logging
  *  random {boolean} - Randomize page order for debugging when true
  *  patient {boolean} - Wait longer and retry more times for rate-limited external URLS
+ *  bail {boolean} - Throw an error on the first page (not permalink) that has >0 flaws
  *
  */
 async function main(core, octokit, uploadArtifact, opts = {}) {
@@ -526,7 +519,7 @@ function getPages(pageList, languages, filters, files, max) {
 }
 
 async function processPage(core, page, pageMap, redirects, opts) {
-  const { verbose, verboseUrl } = opts
+  const { verbose, verboseUrl, bail } = opts
 
   const allFlawsEach = await Promise.all(
     page.permalinks.map((permalink) => {
@@ -540,6 +533,13 @@ async function processPage(core, page, pageMap, redirects, opts) {
     if (verbose) {
       printFlaws(core, allFlaws, { verboseUrl })
     }
+
+    if (bail) {
+      if (!verbose) {
+        console.warn('Use --verbose to see the flaws before it exits')
+      }
+      throw new Error(`More than one flaw in ${page.relativePath}`)
+    }
   }
 
   return allFlaws
@@ -828,7 +828,7 @@ async function innerFetch(core, url, config = {}) {
   // So there's no point in trying more attempts than 3 because it would
   // just timeout on the 10s. (i.e. 1000 + 2000 + 4000 + 8000 > 10,000)
   const retry = {
-    limit: patient ? 5 : 2,
+    limit: patient ? 6 : 2,
   }
   const timeout = { request: patient ? 10000 : 2000 }
 

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

@@ -45,6 +45,7 @@ jobs:
           REPORT_REPOSITORY: github/docs-content
           CREATE_REPORT: true
           CHECK_EXTERNAL_LINKS: true
+          PATIENT: true
         timeout-minutes: 30
         run: node .github/actions/rendered-content-link-checker.js
 

.github/workflows/link-check-on-pr.yml

@@ -26,7 +26,7 @@ concurrency:
 jobs:
   check-links:
     runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
-    if: (github.repository == 'github/docs-internal' || github.repository == 'github/docs') && github.repository_owner == 'github'
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     steps:
       - name: Checkout
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
@@ -72,7 +72,7 @@ jobs:
           LEVEL: 'critical'
           ACTION_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
           GITHUB_TOKEN: ${{ secrets.DOCS_BOT_FR }}
-          SHOULD_COMMENT: true
+          SHOULD_COMMENT: ${{ secrets.DOCS_BOT_FR != '' }}
           CHECK_EXTERNAL_LINKS: false
           CREATE_REPORT: false
         run: node .github/actions/rendered-content-link-checker.js

.github/workflows/orphaned-assets-check.yml

@@ -7,7 +7,7 @@ name: 'Orphaned assets check'
 on:
   workflow_dispatch:
   schedule:
-    - cron: '13 10 * * *' # Once a day at 10:13 UTC
+    - cron: '20 11 * * 1' # run every Monday at 11:20AM UTC
 
 permissions:
   contents: read
@@ -17,13 +17,46 @@ jobs:
     if: ${{ github.repository == 'github/docs-internal' }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - name: Checkout English repo
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
         with:
           # Using a PAT is necessary so that the new commit will trigger the
           # CI in the PR. (Events from GITHUB_TOKEN don't trigger new workflows.)
           token: ${{ secrets.DOCUBOT_REPO_PAT }}
 
+      # TODO: Can be removed after we no longer keep translations in-repo
+      - name: Remove existing language translations
+        run: |
+          rm -rf translations
+
+      - name: Checkout the es-es repo
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        with:
+          repository: github/docs-internal.es-es
+          token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
+          path: translations/es-ES
+
+      - name: Checkout the pt-br repo
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        with:
+          repository: github/docs-internal.pt-br
+          token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
+          path: translations/pt-BR
+
+      - name: Checkout the zh-cn repo
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        with:
+          repository: github/docs-internal.zh-cn
+          token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
+          path: translations/zh-CN
+
+      - name: Checkout the ja-jp repo
+        uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
+        with:
+          repository: github/docs-internal.ja-jp
+          token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
+          path: translations/ja-JP
+
       - name: Setup node
         uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
         with:
@@ -43,7 +76,7 @@ jobs:
           ./script/find-orphaned-assets.js | xargs git rm
 
           # If nothing to commit, exit now. It's fine. No orphans.
-          git status | grep 'nothing to commit' && exit 0
+          git status -- ':!translations*' | grep 'nothing to commit' && exit 0
 
           # Replicated from the translation pipeline PR-maker Action
           git config --global user.name "docubot"

.github/workflows/remove-unused-assets.yml

@@ -10,9 +10,6 @@ versions:
   ghec: '*'
 learningTracks:
   - getting_started
-  - continuous_integration
-  - continuous_deployment
-  - deploy_to_the_cloud
   - adopting_github_actions_for_your_enterprise_ghec
   - adopting_github_actions_for_your_enterprise_ghes_and_ghae
   - hosting_your_own_runners