Merge branch 'main' into jules-6323

Author: jules-p

.github/actions-scripts/openapi-schema-branch.js

@@ -36,7 +36,7 @@ const changedFiles = execSync('git diff --name-only HEAD').toString()
 if (changedFiles !== '') {
   console.log(`These files were changed:\n${changedFiles}`)
   console.log(
-    `🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. \n\n If this test is failing after updates to the script/rest directory, run script/rest/update-files.js --decorate-only to re-generate the decorated files from the existing dereferenced files and check those in. \n\n If this test is failing after an update to a package, check the changes the new package makes to the decorated files by running script/rest/update-files.js --decorate-only. If the changes are small style changes that don't impact the overall experience, check the updated decorated file in. Otherwise, more work may be needed to be compatible with the updated package. \n\n For more information, see 'script/rest/README.md'. 🛑`
+    `🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. \n\n If this test is failing after updates to the script/rest directory, run script/rest/update-files.js --decorate-only to re-generate the decorated files from the existing dereferenced files and check those in. \n\n If this test is failing after an update to a package, check the changes the new package makes to the decorated files by running script/rest/update-files.js --decorate-only.\n\nIf you updated script/rest/utils/rest-api-overrides.json, you'll need to run script/rest/update-files.js --decorate-only to regenerate the decorated file and redirects file (check in the changed lib/rest/static/decorated files).\n\nIf the changes are small style changes that don't impact the overall experience, check the updated decorated file in. Otherwise, more work may be needed to be compatible with the updated package. \n\n For more information, see 'script/rest/README.md'. 🛑`
   )
   process.exit(1)
 }

.github/workflows/optimize-images.yml

@@ -6,28 +6,47 @@ name: Optimize images
 
 on:
   workflow_dispatch:
-  schedule:
-    - cron: '45 17 * * 2' # Run Tuesdays at 17:45 UTC / 9:45 PST
+  pull_request:
+    paths:
+      - '**/*.png'
 
 permissions:
   contents: write
   pull-requests: write
 
 jobs:
-  optimize-images:
-    if: github.repository == 'github/docs-internal'
+  optimize-images-on-pr:
+    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
     runs-on: ubuntu-latest
     steps:
-      - name: Check out repo
+      - name: Check out repo on head ref
         uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Check out base ref
+        run: git fetch --no-tags --depth=1 origin $GITHUB_BASE_REF
 
       - name: Install the Optipng package
         run: sudo apt-get update && sudo apt-get -y install optipng
 
-      - name: Run the Optipng package
-        run: find . -name '*.png' -print0 | xargs -0 optipng -nx
+      - name: Run optipng on new or changed images
+        run: |
+          set -e # exit when any command fails
+
+          echo "Ensure we can view $GITHUB_BASE_REF"
+          git checkout $GITHUB_BASE_REF
+
+          echo "Ensure we can view $GITHUB_HEAD_REF"
+          git checkout $GITHUB_HEAD_REF
 
-      - name: Make a branch, commit, push, and pull request
+          echo "List the files that changed"
+          git diff --name-only $GITHUB_HEAD_REF $GITHUB_BASE_REF
+
+          echo "Run optipng on pngs in from the diff"
+          git diff --name-only -z $GITHUB_HEAD_REF $GITHUB_BASE_REF -- '*.png' | xargs -0 optipng -nx
+
+      - name: Make a commit and a push
         run: |
           echo "If there's no changes, exit"
           if [[ !  `git status --porcelain` ]]
@@ -36,20 +55,13 @@ jobs:
             exit 0
           fi
 
-          echo "Make a new branch"
-          BRANCH="optimize-images-$(date +'%Y%m%d%H%M%S')"
-          git checkout -b $BRANCH
-
           echo "Make a commit"
           git config user.name github-actions
           git config user.email [email protected]
           git add "*.png"
           git commit --message="Optimize images"
 
           echo "Push up changes"
-          git push --set-upstream origin $BRANCH
-
-          echo "Open a pull request"
-          gh pr create --title "Optimize images" --body "Optimize images"
+          git push
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/triage-unallowed-contributions.yml

@@ -21,6 +21,7 @@ on:
       - 'package*.json'
       - 'script/**'
       - 'translations/**'
+      - 'content/actions/deployment/security-hardening-your-deployments/**'
 
 permissions:
   pull-requests: write
@@ -67,6 +68,7 @@ jobs:
               - 'package*.json'
               - 'scripts/**'
               - 'translations/**'
+              - 'content/actions/deployment/security-hardening-your-deployments/**'
 
       # When there are changes to files we can't accept, leave a comment
       # explaining this to the PR author
@@ -90,6 +92,7 @@ jobs:
               'package*.json',
               'scripts/**',
               'translations/**',
+              'content/actions/deployment/security-hardening-your-deployments/**',
             ]
 
             const badFiles = badFilesArr.join('\n')

assets/images/help/pull_requests/confirm-auto-merge-button.png

@@ -6,7 +6,7 @@ import { SmallFooter } from 'components/page-footer/SmallFooter'
 import { ScrollButton } from 'components/ui/ScrollButton'
 import { SupportSection } from 'components/page-footer/SupportSection'
 import { DeprecationBanner } from 'components/page-header/DeprecationBanner'
-import { RestRepoBanner } from 'components/page-header/RestRepoBanner'
+import { RestBanner } from 'components/page-header/RestBanner'
 import { useMainContext } from 'components/context/MainContext'
 import { useTranslation } from 'components/hooks/useTranslation'
 import { useRouter } from 'next/router'
@@ -89,7 +89,7 @@ export const DefaultLayout = (props: Props) => {
         <Header />
         <main id="main-content">
           <DeprecationBanner />
-          <RestRepoBanner />
+          <RestBanner />
 
           {props.children}
         </main>

assets/images/help/pull_requests/pull-request-information-fields-enterprise.png

@@ -55,3 +55,17 @@
 .versionSearchContainer {
   overflow: hidden;
 }
+
+// The value in the /cb-XXXXX prefix on the URL isn't important. It just
+// needs to be unique so the asset can be cached in the CDN beyond
+// every prod deployment.
+// Just remember to change it if you change the image.
+.searchIconBackground24 {
+  background: var(--color-canvas-default)
+    url("/assets/cb-303/images/octicons/search-24.svg") no-repeat 12px;
+}
+
+.searchIconBackground16 {
+  background: var(--color-canvas-default)
+    url("/assets/cb-262/images/octicons/search-16.svg") no-repeat 6px;
+}

components/DefaultLayout.tsx

@@ -224,7 +224,9 @@ export function Search({
               ref={inputRef}
               className={cx(
                 styles.searchInput,
+                iconSize === 24 && styles.searchIconBackground24,
                 iconSize === 24 && 'form-control px-6 f4',
+                iconSize === 16 && styles.searchIconBackground16,
                 iconSize === 16 && 'form-control px-5 f4',
                 variant === 'compact' && 'py-2',
                 variant === 'expanded' && 'py-3',
@@ -233,11 +235,6 @@ export function Search({
                 isHeaderSearch && query && styles.searchInputExpanded,
                 isHeaderSearch && query && 'position-absolute top-0 right-0'
               )}
-              style={{
-                background: `var(--color-canvas-default) url("/assets/images/octicons/search-${iconSize}.svg") no-repeat ${
-                  iconSize === 24 ? '12px' : '6px'
-                }`,
-              }}
               type="search"
               placeholder={t`placeholder`}
               autoComplete="off"

components/Search.module.scss

@@ -107,7 +107,11 @@ export const ArticlePage = () => {
     // In the future there might be more.
     // Hopefully, we can some day delete all of this and no longer
     // be dependent on the URL hash to do the redirect.
-    if (hash && pathname.endsWith('/rest/reference/repos')) {
+    if (
+      hash &&
+      (pathname.endsWith('/rest/reference/repos') ||
+        pathname.endsWith('/rest/reference/enterprise-admin'))
+    ) {
       setLoadClientsideRedirectExceptions(true)
     }
   }, [])

components/Search.tsx

@@ -0,0 +1,81 @@
+import React from 'react'
+import { Flash } from '@primer/components'
+import { useRouter } from 'next/router'
+import { Link } from 'components/Link'
+
+const restRepoDisplayPages = [
+  '/rest/reference/branches',
+  '/rest/reference/collaborators',
+  '/rest/reference/commits',
+  '/rest/reference/deployments',
+  '/rest/reference/pages',
+  '/rest/reference/releases',
+  '/rest/reference/repos',
+  '/rest/reference/metrics',
+  '/rest/reference/webhooks',
+]
+const restEnterpriseDisplayPages = ['/rest/reference/enterprise-admin']
+const restRepoCategoryExceptionsTitles = {
+  branches: 'Branches',
+  collaborators: 'Collaborators',
+  commits: 'Commits',
+  deployments: 'Deployments',
+  pages: 'GitHub Pages',
+  releases: 'Releases',
+  metrics: 'Metrics',
+  webhooks: 'Webhooks',
+}
+
+export const RestBanner = () => {
+  const router = useRouter()
+  const restPage = (router.query.restPage as string[]) || []
+  const asPathRoot = `/${router.query.productId}/${restPage.join('/')}`
+  if (
+    !restRepoDisplayPages.includes(asPathRoot) &&
+    !restEnterpriseDisplayPages.includes(asPathRoot)
+  ) {
+    return null
+  }
+
+  let noticeString
+
+  if (restRepoDisplayPages.includes(asPathRoot)) {
+    const pages = Object.keys(restRepoCategoryExceptionsTitles) as Array<
+      keyof typeof restRepoCategoryExceptionsTitles
+    >
+    const newRestPagesText = pages.map((page, i) => [
+      <React.Fragment key={page}>
+        <Link href={`/${router.locale}/rest/reference/${page}`}>
+          {restRepoCategoryExceptionsTitles[page]}
+        </Link>
+        {i < pages.length - 1 && ', '}
+      </React.Fragment>,
+    ])
+
+    noticeString = (
+      <React.Fragment>
+        If you can't find what you're looking for, you might try the new {newRestPagesText} REST API
+        pages.
+      </React.Fragment>
+    )
+  } else if (restEnterpriseDisplayPages.includes(asPathRoot)) {
+    noticeString = (
+      <React.Fragment>
+        If you can't find what you're looking for, you might try the{' '}
+        <Link href={`/${router.locale}/rest/reference/actions`}>Actions</Link> REST API page.
+      </React.Fragment>
+    )
+  }
+
+  return (
+    <div data-testid="rest-api-repos-banner" className="container-xl mt-3 mx-auto p-responsive">
+      <Flash variant="warning">
+        <p>
+          <b className="text-bold">
+            <span>We've recently moved some of the REST API documentation. {noticeString}</span>
+          </b>{' '}
+        </p>
+      </Flash>
+    </div>
+  )
+}