Merge branch 'main' into patch-3

Author: SIkebe

.github/actions-scripts/staging-commit-status-success.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+import * as github from '@actions/github'
+
 import getOctokit from '../../script/helpers/github.js'
 
 const { GITHUB_TOKEN } = process.env
@@ -25,6 +27,10 @@ if (!HEAD_SHA) {
   throw new Error('$HEAD_SHA not set')
 }
 
+const { context } = github
+const owner = context.repo.owner
+const repo = context.payload.repository.name
+
 await octokit.repos.createCommitStatus({
   owner,
   repo,

assets/images/help/overview/sign-in-pattern.png

@@ -6,6 +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 { useMainContext } from 'components/context/MainContext'
 import { useTranslation } from 'components/hooks/useTranslation'
 import { useRouter } from 'next/router'
@@ -86,6 +87,7 @@ export const DefaultLayout = (props: Props) => {
       <main className="flex-1 min-width-0">
         <Header />
         <DeprecationBanner />
+        <RestRepoBanner />
 
         {props.children}
 

components/DefaultLayout.tsx

@@ -1,5 +1,6 @@
 import { useState } from 'react'
 import { ArrowRightIcon, SearchIcon } from '@primer/octicons-react'
+import { Text } from '@primer/components'
 
 import { useProductLandingContext } from 'components/context/ProductLandingContext'
 import { useTranslation } from 'components/hooks/useTranslation'
@@ -31,6 +32,16 @@ export const CodeExamples = () => {
   return (
     <div>
       <div className="pr-lg-3 mb-5 mt-3">
+        <Text
+          className="ml-1 mr-2"
+          fontWeight="bold"
+          fontSize={2}
+          as="label"
+          htmlFor="searchCodeExamples"
+          id="searchCodeExamples"
+        >
+          Search code examples:
+        </Text>
         <input
           data-testid="code-examples-input"
           className="input-lg py-2 px-3 col-12 col-lg-8 form-control"
@@ -45,9 +56,9 @@ export const CodeExamples = () => {
       <div className="d-flex flex-wrap gutter">
         {(isSearching ? searchResults : productCodeExamples.slice(0, numVisible)).map((example) => {
           return (
-            <div key={example.href} className="col-12 col-xl-4 col-lg-6 mb-4">
+            <li key={example.href} className="col-12 col-xl-4 col-lg-6 mb-4 list-style-none">
               <CodeExampleCard example={example} />
-            </div>
+            </li>
           )
         })}
       </div>

components/landing/CodeExamples.tsx

@@ -8,7 +8,7 @@ export const GuideCard = ({ guide }: Props) => {
   const authorString = `@${authors.join(', @')}`
 
   return (
-    <div className="col-lg-4 col-12 mb-4">
+    <li className="col-lg-4 col-12 mb-4 list-style-none">
       <a
         className="Box color-shadow-medium height-full d-block hover-shadow-large no-underline color-fg-default p-5"
         href={guide.href}
@@ -50,6 +50,6 @@ export const GuideCard = ({ guide }: Props) => {
           <div>{authorString}</div>
         </footer>
       </a>
-    </div>
+    </li>
   )
 }

components/landing/GuideCard.tsx

@@ -0,0 +1,58 @@
+import { Flash } from '@primer/components'
+import { useRouter } from 'next/router'
+import { Link } from 'components/Link'
+
+const restDisplayPages = [
+  '/rest/reference/branches',
+  '/rest/reference/collaborators',
+  '/rest/reference/commits',
+  '/rest/reference/deployments',
+  '/rest/reference/pages',
+  '/rest/reference/releases',
+  '/rest/reference/repos',
+  '/rest/reference/repository-metrics',
+  '/rest/reference/webhooks',
+]
+const restRepoCategoryExceptionsTitles = {
+  branches: 'Branches',
+  collaborators: 'Collaborators',
+  commits: 'Commits',
+  deployments: 'Deployments',
+  pages: 'Github Pages',
+  releases: 'Releases',
+  'repository-metrics': 'Repository metrics',
+  webhooks: 'Webhooks',
+}
+
+export const RestRepoBanner = () => {
+  const router = useRouter()
+  const asPathRoot = router.asPath.split('?')[0].split('#')[0]
+  if (!restDisplayPages.includes(asPathRoot)) {
+    return null
+  }
+
+  const pages = Object.keys(restRepoCategoryExceptionsTitles) as Array<
+    keyof typeof restRepoCategoryExceptionsTitles
+  >
+  const newRestPagesText = pages.map((page, i) => [
+    <Link href={`/${router.locale}/rest/reference/${page}`}>
+      {restRepoCategoryExceptionsTitles[page]}
+      {i < pages.length - 1 && ', '}
+    </Link>,
+  ])
+
+  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. If you can't find what you're
+              looking for, you might try the new {newRestPagesText} REST API pages.
+            </span>
+          </b>{' '}
+        </p>
+      </Flash>
+    </div>
+  )
+}

components/page-header/RestRepoBanner.tsx

@@ -24,6 +24,6 @@ To view current and past deployments, click **Environments** on the home page of
 
 The deployments page displays the last active deployment of each environment for your repository. If the deployment includes an environment URL, a **View deployment** button that links to the URL is shown next to the deployment.
 
-The activity log shows the deployment history for your environments. By default, only the most recent deployment for an environment has an `Active` status; all previously active deployments have an `Inactive` status. For more information on automatic inactivation of deployments, see "[Inactive deployments](/rest/reference/repos#inactive-deployments)."
+The activity log shows the deployment history for your environments. By default, only the most recent deployment for an environment has an `Active` status; all previously active deployments have an `Inactive` status. For more information on automatic inactivation of deployments, see "[Inactive deployments](/rest/reference/deployments#inactive-deployments)."
 
 You can also use the REST API to get information about deployments. For more information, see "[Repositories](/rest/reference/repos#deployments)."

content/actions/deployment/managing-your-deployments/viewing-deployment-history.md

@@ -307,7 +307,7 @@ on:
 
 ### `deployment_status`
 
-Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/rest/reference/repos#create-a-deployment-status)."
+Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/rest/reference/deployments#create-a-deployment-status)."
 
 | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
 | --------------------- | -------------- | ------------ | -------------|
@@ -701,7 +701,7 @@ on:
 
 {% note %}
 
-**Note:** The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the REST API. For more information, see "[Get a commit](/rest/reference/repos#get-a-commit)".
+**Note:** The webhook payload available to GitHub Actions does not include the `added`, `removed`, and `modified` attributes in the `commit` object. You can retrieve the full commit object using the REST API. For more information, see "[Get a commit](/rest/reference/commits#get-a-commit)".
 
 {% endnote %}
 

content/actions/learn-github-actions/events-that-trigger-workflows.md

@@ -1,7 +1,7 @@
 ---
 title: Disabling unauthenticated sign-ups
 redirect_from:
-  - /enterprise/admin/articles/disabling-sign-ups/
+  - /enterprise/admin/articles/disabling-sign-ups
   - /enterprise/admin/user-management/disabling-unauthenticated-sign-ups
   - /enterprise/admin/authentication/disabling-unauthenticated-sign-ups
   - /admin/authentication/disabling-unauthenticated-sign-ups

content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/disabling-unauthenticated-sign-ups.md

@@ -2,10 +2,10 @@
 title: Authenticating users for your GitHub Enterprise Server instance
 intro: 'You can use {% data variables.product.prodname_ghe_server %}''s built-in authentication, or choose between CAS, LDAP, or SAML to integrate your existing accounts and centrally manage user access to {% data variables.product.product_location %}.'
 redirect_from:
-  - /enterprise/admin/categories/authentication/
-  - /enterprise/admin/guides/installation/user-authentication/
-  - /enterprise/admin/articles/inviting-users/
-  - /enterprise/admin/guides/migrations/authenticating-users-for-your-github-enterprise-instance/
+  - /enterprise/admin/categories/authentication
+  - /enterprise/admin/guides/installation/user-authentication
+  - /enterprise/admin/articles/inviting-users
+  - /enterprise/admin/guides/migrations/authenticating-users-for-your-github-enterprise-instance
   - /enterprise/admin/user-management/authenticating-users-for-your-github-enterprise-server-instance
   - /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance
 versions: