Merge branch 'main' into patch-4

Author: mchammer01

.github/allowed-actions.js

@@ -18,6 +18,7 @@ export default [
   'dawidd6/action-download-artifact@af92a8455a59214b7b932932f2662fdefbd78126', // v2.15.0
   'docker://chinthakagodawita/autoupdate-action:v1',
   'dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58',
+  'trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b', // v1.2.4
   'github/codeql-action/analyze@v1',
   'github/codeql-action/init@v1',
   'juliangruber/approve-pull-request-action@c530832d4d346c597332e20e03605aa94fa150a8',

.github/workflows/check-broken-links-github-github.yml

@@ -59,11 +59,11 @@ jobs:
       #
       # https://docs.github.com/actions/reference/context-and-expression-syntax-for-github-actions#job-status-check-functions
 
-      - if: ${{ failure() }}
+      - if: ${{ failure() && env.FREEZE != 'true' }}
         name: Get title for issue
         id: check
         run: echo "::set-output name=title::$(head -1 broken_github_github_links.md)"
-      - if: ${{ failure() }}
+      - if: ${{ failure() && env.FREEZE != 'true'}}
         name: Create issue from file
         id: github-github-broken-link-report
         uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e

.github/workflows/enterprise-dates.yml

@@ -68,7 +68,7 @@ jobs:
           branch: enterprise-server-dates-update
           delete-branch: true
 
-      - if: ${{ failure() }}
+      - if: ${{ failure() && env.FREEZE != 'true' }}
         name: Delete remote branch (if previous steps failed)
         uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911
         with:
@@ -84,7 +84,7 @@ jobs:
 
       - name: Send Slack notification if workflow fails
         uses: someimportantcompany/github-actions-slack-message@f8d28715e7b8a4717047d23f48c39827cacad340
-        if: failure()
+        if: ${{ failure() && env.FREEZE != 'true' }}
         with:
           channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
           bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

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

@@ -58,7 +58,7 @@ jobs:
           project: Core docs work for the current week
           project-column: Should do
           branch: remove-unused-assets
-      - if: ${{ failure() }}
+      - if: ${{ failure() && env.FREEZE != 'true' }}
         name: Delete remote branch (if previous steps failed)
         uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911
         with:

.github/workflows/test.yml

@@ -46,6 +46,18 @@ jobs:
           # Enables cloning the Early Access repo later with the relevant PAT
           persist-credentials: 'false'
 
+      - name: Gather files changed
+        uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
+        id: get_diff_files
+        with:
+          # So that `steps.get_diff_files.outputs.files` becomes
+          # a string like `foo.js path/bar.md`
+          output: ' '
+
+      - name: Insight into changed files
+        run: |
+          echo ${{ steps.get_diff_files.outputs.files }}
+
       - name: Setup node
         uses: actions/setup-node@270253e841af726300e85d718a5f606959b2903c
         with:
@@ -67,4 +79,6 @@ jobs:
         run: npm run build
 
       - name: Run tests
+        env:
+          DIFF_FILES: ${{ steps.get_diff_files.outputs.files }}
         run: npm run test tests/${{ matrix.test-group }}/

.github/workflows/update-graphql-files.yml

@@ -75,7 +75,7 @@ jobs:
           number: ${{ steps.create-pull-request.outputs.pull-request-number }}
       - name: Send Slack notification if workflow fails
         uses: someimportantcompany/github-actions-slack-message@f8d28715e7b8a4717047d23f48c39827cacad340
-        if: failure()
+        if: ${{ failure() && env.FREEZE != 'true' }}
         with:
           channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
           bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}

assets/images/help/repository/required-statuses-list.png

@@ -7,6 +7,7 @@ import { useTranslation } from 'components/hooks/useTranslation'
 import { sendEvent, EventType } from 'components/lib/events'
 import { useMainContext } from './context/MainContext'
 import { useVersion } from 'components/hooks/useVersion'
+import { useQuery } from 'components/hooks/useQuery'
 import { useLanguages } from './context/LanguagesContext'
 
 import styles from './Search.module.scss'
@@ -36,10 +37,7 @@ export function Search({
   children,
 }: Props) {
   const router = useRouter()
-  const query =
-    router.query.query && Array.isArray(router.query.query)
-      ? router.query.query[0]
-      : router.query.query || ''
+  const { query, debug } = useQuery()
   const [localQuery, setLocalQuery] = useState(query)
   const [debouncedQuery, setDebouncedQuery] = useDebounce<string>(localQuery, 300)
   const inputRef = useRef<HTMLInputElement>(null)
@@ -185,7 +183,7 @@ export function Search({
           isLoading={isLoading}
           results={previousResults}
           closeSearch={closeSearch}
-          debug={'debug' in router.query}
+          debug={debug}
           query={query}
         />
       </div>
@@ -279,7 +277,7 @@ function ShowSearchResults({
   results: SearchResult[] | undefined
   closeSearch: () => void
   debug: boolean
-  query: string | string[]
+  query: string
 }) {
   const { t } = useTranslation('search')
   const router = useRouter()
@@ -298,7 +296,13 @@ function ShowSearchResults({
       version: version,
     }
   })
-  const redirectQuery = query ? `?query=${query}` : ''
+
+  const redirectParams: {
+    query: string
+    debug?: string
+  } = { query }
+  if (debug) redirectParams.debug = JSON.stringify(debug)
+  const redirectQuery = `?${new URLSearchParams(redirectParams).toString()}`
 
   if (results) {
     if (results.length === 0) {
@@ -350,7 +354,7 @@ function ShowSearchResults({
               renderItem: () => (
                 <ActionList.Item as="div">
                   <Link href={url} className="no-underline color-fg-default">
-                    <li key={url} data-testid="search-result" className={cx('list-style-none')}>
+                    <li data-testid="search-result" className={cx('list-style-none')}>
                       <div className={cx('py-2 px-3')}>
                         {/* Breadcrumbs in search records don't include the page title. These fields may contain <mark> elements that we need to render */}
                         <Label variant="small" sx={{ bg: 'accent.emphasis' }}>

components/Search.tsx

@@ -1,6 +1,6 @@
 import { useRouter } from 'next/router'
 import cx from 'classnames'
-import { Heading } from '@primer/components'
+import { ActionList, Heading } from '@primer/components'
 
 import { ZapIcon, InfoIcon, ShieldLockIcon } from '@primer/octicons-react'
 import { Callout } from 'components/ui/Callout'
@@ -45,12 +45,19 @@ export const ArticlePage = () => {
 
   const renderTocItem = (item: MiniTocItem) => {
     return (
-      <li key={item.contents} className={cx(item.platform, 'mb-2 lh-condensed')}>
-        <div className="mb-2 lh-condensed" dangerouslySetInnerHTML={{ __html: item.contents }} />
-        {item.items && item.items.length > 0 ? (
-          <ul className="list-style-none pl-0 f5 mb-0 ml-3">{item.items.map(renderTocItem)}</ul>
-        ) : null}
-      </li>
+      <ActionList.Item
+        as="div"
+        key={item.contents}
+        className={item.platform}
+        sx={{ listStyle: 'none', padding: '2px' }}
+      >
+        <div className={cx('lh-condensed')}>
+          <div dangerouslySetInnerHTML={{ __html: item.contents }} />
+          {item.items && item.items.length > 0 ? (
+            <ul className="ml-3">{item.items.map(renderTocItem)}</ul>
+          ) : null}
+        </div>
+      </ActionList.Item>
     )
   }
 
@@ -111,13 +118,19 @@ export const ArticlePage = () => {
               {miniTocItems.length > 1 && (
                 <>
                   <Heading as="h2" fontSize={1} id="in-this-article" className="mb-1">
-                    <a className="Link--primary" href="#in-this-article">
-                      {t('miniToc')}
-                    </a>
+                    <Link href="#in-this-article">{t('miniToc')}</Link>
                   </Heading>
-                  <ul className="list-style-none pl-0 f5 mb-0">
-                    {miniTocItems.map(renderTocItem)}
-                  </ul>
+
+                  <ActionList
+                    key={title}
+                    items={miniTocItems.map((items) => {
+                      return {
+                        key: title,
+                        text: title,
+                        renderItem: () => <ul>{renderTocItem(items)}</ul>,
+                      }
+                    })}
+                  />
                 </>
               )}
             </>

components/article/ArticlePage.tsx

@@ -0,0 +1,29 @@
+import { useRouter } from 'next/router'
+
+type QueryInfo = {
+  query: string
+  debug: boolean
+}
+export const useQuery = (): QueryInfo => {
+  const router = useRouter()
+  const query =
+    router.query.query && Array.isArray(router.query.query)
+      ? router.query.query[0]
+      : router.query.query || ''
+
+  let debug = false
+  if (router.query.debug) {
+    // Now `router.query.debug` is either string or any array of strings
+    debug = Boolean(
+      JSON.parse(Array.isArray(router.query.debug) ? router.query.debug[0] : router.query.debug)
+    )
+  } else if (router.query.debug === '') {
+    // E.g. `?query=foo&debug` should be treated as truthy
+    debug = true
+  }
+
+  return {
+    query,
+    debug,
+  }
+}