Merge pull request github#28371 from github/repo-sync

docs-bot · web-flow · commit 58e51186fd26 · 2023-09-20T09:33:13.000-07:00
Repo sync
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -24,66 +24,67 @@ env:
   ELASTICSEARCH_URL: http://localhost:9200/
 
 jobs:
-  figureOutMatrix:
-    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
-    runs-on: ubuntu-latest
-    outputs:
-      matrix: ${{ steps.set-matrix.outputs.result }}
-    steps:
-      - uses: actions/github-script@98814c53be79b1d30f795b907e553d8679345975
-        id: set-matrix
-        with:
-          script: |
-            // We only want to run the 'languages' suite when we know
-            // we're on the private docs-internal repo because only that
-            // one has ability to clone the remote (private) languages
-            // repos.
-            // You can run multiple paths per suite as space-separated in `path`.
-            // Note that *if you add* to this, remember to also add that
-            // to the **required checks** in the branch protection rules.
-            return [
-              { name: 'assets', path: 'src/assets/tests', },
-              // { name: 'audit-logs', path: 'src/assets/audit-logs', },
-              { name: 'automated-pipelines', path: 'src/automated-pipelines/tests', },
-              { name: 'color-schemes', path: 'src/color-schemes/tests', },
-              { name: 'content', path: 'tests/content', },
-              { name: 'content-linter', path: 'src/content-linter/tests', },
-              { name: 'content-render', path: 'src/content-render/tests', },
-              { name: 'events', path: 'src/events/tests', },
-              { name: 'ghes-releases', path: 'src/ghes-releases/tests', },
-              { name: 'github-apps', path: 'src/github-apps/tests', },
-              { name: 'graphql', path: 'src/graphql/tests', },
-              { name: 'landings', path: 'src/landings/tests', },
-              { name: 'learning-track', path: 'src/learning-track/tests', },
-              { name: 'observability', path: 'src/observability/tests' },
-              { name: 'pageinfo', path: 'src/pageinfo/tests', },
-              { name: 'redirects', path: 'src/redirects/tests', },
-              { name: 'release-notes', path: 'src/release-notes/tests', },
-              { name: 'rendering', path: 'tests/rendering', },
-              { name: 'rendering-fixtures', path: 'tests/rendering-fixtures', },
-              { name: 'rest', path: 'src/rest/tests', },
-              { name: 'routing', path: 'tests/routing', },
-              { name: 'search', path: 'src/search/tests', },
-              { name: 'secret-scanning', path: 'src/secret-scanning/tests',},
-              { name: 'shielding', path: 'src/shielding/tests', },
-              context.payload.repository.full_name === 'github/docs-internal' &&
-                { name: 'languages', path: 'src/languages/tests', },
-              { name: 'unit', path: 'tests/unit', },
-              // { name: 'tools', path: 'src/tools/tests', }
-              { name: 'webhooks', path: 'src/webhooks/tests', },
-            ].filter(Boolean)
-
   test:
     name: ${{ matrix.name }}
-    needs: figureOutMatrix
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
+
     # Run on ubuntu-20.04-xl if the private repo or ubuntu-latest if the public repo
     # See pull # 17442 in the private repo for context
     runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
     timeout-minutes: 60
     strategy:
       fail-fast: false
       matrix:
-        include: ${{ fromJSON(needs.figureOutMatrix.outputs.matrix) }}
+        # Note that *if you add* to this, remember to also add that
+        # to the **required checks** in the branch protection rules.
+        name:
+          # tests/ directory
+          - content
+          - rendering
+          - rendering-fixtures
+          - routing
+          - unit
+
+          # src/ directory
+          - archives
+          - assets
+          # - audit-logs
+          - automated-pipelines
+          # - codeql-cli
+          - color-schemes
+          - content-linter
+          - content-render
+          - early-access
+          - events
+          # - frame
+          - ghes-releases
+          - github-apps
+          - graphql
+          - landings
+          - languages
+          - learning-track
+          # - links
+          - observability
+          # - open-source
+          - pageinfo
+          # - pages
+          - redirects
+          - release-notes
+          - rest
+          - search
+          - secret-scanning
+          - shielding
+          # - tools
+          - versions
+          - webhooks
+
+        # The languages suite only runs on docs-internal
+        isPrivateRepo:
+          - ${{ github.repository == 'github/docs-internal' }}
+        exclude:
+          - name: languages
+            isPrivateRepo: false
+
     steps:
       # Each of these ifs needs to be repeated at each step to make sure the required check still runs
       # Even if if doesn't do anything
@@ -185,4 +186,10 @@ jobs:
           ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }}
           ROOT: ${{ (matrix.name == 'rendering-fixtures' || matrix.name == 'pageinfo' || matrix.name == 'landings' ) && 'tests/fixtures' || '' }}
           TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'rendering-fixtures' || matrix.name == 'pageinfo') && 'tests/fixtures/translations' || '' }}
-        run: npm test -- ${{ matrix.path }}/
+        run: |
+          if [ -d "tests/${{ matrix.name }}/" ]
+          then
+            npm test -- tests/${{ matrix.name }}/
+          else
+            npm test -- src/${{ matrix.name }}/tests/
+          fi
diff --git a/src/content-linter/tests/unit/internal-link-punctuation.js b/src/content-linter/tests/unit/internal-link-punctuation.js
@@ -43,4 +43,15 @@ describe(internalLinkPunctuation.names.join(' - '), () => {
     expect(errors[0].errorRange).toEqual([2, 30])
     expect(errors[9].lineNumber).toBe(10)
   })
+  test('links that is not plain text', async () => {
+    const markdown = [
+      '[*emphasize*](./image.png)',
+      '[**boldness**](./image.png)',
+      '[**boldness** and *emphasize*](./image.png)',
+    ].join('\n')
+
+    const result = await runRule(internalLinkPunctuation, { markdown })
+    const errors = result.markdown
+    expect(errors.length).toBe(0)
+  })
 })
diff --git a/src/content-render/unified/rewrite-asset-img-tags.js b/src/content-render/unified/rewrite-asset-img-tags.js
@@ -1,27 +1,5 @@
 import { visit, SKIP } from 'unist-util-visit'
 
-/**
- * `structuredClone` was added in Node 17 and onwards.
- * https://developer.mozilla.org/en-US/docs/Web/API/structuredClone#browser_compatibility
- *
- * At the time of writing, we use Node 18 in CI and in production, but
- * someone might be previewing locally with an older version so
- * let's make a quick polyfill.
- * We could add a specific (`js-core`) package for this polyfill, but it's
- * fortunately not necessary in this context because it's safe enough
- * clone by turning into a string and back again.
- */
-function structuredClonePolyfill(obj) {
-  if (typeof structuredClone !== 'undefined') {
-    return structuredClone(obj)
-  } else {
-    // Note, that this naive clone would turn Date objects into strings.
-    // So don't use this polyfill if certain values aren't primitives
-    // that JSON.parse can handle.
-    return JSON.parse(JSON.stringify(obj))
-  }
-}
-
 // This number must match a width we're willing to accept in a dynamic
 // asset URL.
 // (note this is exported for the sake of end-to-end tests' assertions)
@@ -52,7 +30,7 @@ export default function rewriteAssetImgTags() {
   return (tree) => {
     visit(tree, matcher, (node) => {
       if (node.properties.src.endsWith('.png')) {
-        const copyPNG = structuredClonePolyfill(node)
+        const copyPNG = structuredClone(node)
 
         const sourceWEBP = {
           type: 'element',
diff --git a/src/links/lib/update-internal-links.js b/src/links/lib/update-internal-links.js
@@ -20,17 +20,6 @@ import getRedirect, { splitPathByLanguage } from '#src/redirects/lib/get-redirec
 import nonEnterpriseDefaultVersion from '#src/versions/lib/non-enterprise-default-version.js'
 import { deprecated } from '#src/versions/lib/enterprise-server-releases.js'
 
-function objectClone(obj) {
-  try {
-    return structuredClone(obj)
-  } catch {
-    // Need to polyfill for Node 16 folks
-    // Using `yaml.load(yaml.dump(...))` is safe enough because this
-    // data itself came from the Yaml deserializing in frontmatter().
-    return yaml.load(yaml.dump(obj))
-  }
-}
-
 // That magical string that can be turned into th actual title when
 // we, at runtime, render out the links
 const AUTOTITLE = 'AUTOTITLE'
@@ -94,10 +83,7 @@ async function updateFile(file, context, opts) {
   const replacements = []
   const warnings = []
 
-  // The day we know with confidence that everyone us on Node >=17,
-  // we can change this to use `structuredClone` without the polyfill
-  // technique.
-  const newData = objectClone(data)
+  const newData = structuredClone(data)
 
   const ANY = Symbol('any')
   const IS_ARRAY = Symbol('is array')
