Merge pull request #12993 from github/repo-sync

repo sync

Author: Octomerger

components/DefaultLayout.tsx

@@ -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/page-header/RestRepoBanner.tsx

@@ -0,0 +1,52 @@
+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/repos',
+  '/rest/reference/repository-metrics',
+  '/rest/reference/webhooks',
+]
+const restRepoCategoryExceptions = [
+  'Branches',
+  'Collaborators',
+  'Commits',
+  'Deployments',
+  'Github Pages',
+  'Repository metrics',
+  'Webhooks',
+]
+
+export const RestRepoBanner = () => {
+  const router = useRouter()
+  const asPathRoot = router.asPath.split('?')[0].split('#')[0]
+  if (!restDisplayPages.includes(asPathRoot)) {
+    return null
+  }
+
+  const newRestPagesText = restRepoCategoryExceptions.map((page, i) => [
+    <Link href={`/rest/references/${page}`}>
+      {page}
+      {i < restRepoCategoryExceptions.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>
+  )
+}

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

@@ -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/learn-github-actions/events-that-trigger-workflows.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/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md

@@ -82,14 +82,14 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
 
 | Value | Action | More information |
 | :- | :- | :- |
-| <pre>auto-merge deployment api</pre> | Automatic merge of the base branch via a deployment created with the API | "[Repositories](/rest/reference/repos#create-a-deployment)" in the REST API documentation |
+| <pre>auto-merge deployment api</pre> | Automatic merge of the base branch via a deployment created with the API | "[Create a deployment](/rest/reference/deployments#create-a-deployment)" in the REST API documentation |
 | <pre>blob#save</pre> | Change to a file's contents in the web interface | "[Editing files](/repositories/working-with-files/managing-files/editing-files)" |
-| <pre>branch merge api</pre> | Merge of a branch via the API | "[Repositories](/rest/reference/repos#merge-a-branch)" in the REST API documentation |
+| <pre>branch merge api</pre> | Merge of a branch via the API | "[Merge a branch](/rest/reference/branches#merge-a-branch)" in the REST API documentation |
 | <pre>branches page delete button</pre> | Deletion of a branch in the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" |
 | <pre>git refs create api</pre> | Creation of a ref via the API | "[Git database](/rest/reference/git#create-a-reference)" in the REST API documentation |
 | <pre>git refs delete api</pre> | Deletion of a ref via the API | "[Git database](/rest/reference/git#delete-a-reference)" in the REST API documentation |
 | <pre>git refs update api</pre> | Update of a ref via the API | "[Git database](/rest/reference/git#update-a-reference)" in the REST API documentation |
-| <pre>git repo contents api</pre> | Change to a file's contents via the API | "[Repositories](/rest/reference/repos#create-or-update-file-contents)" in the REST API documentation |
+| <pre>git repo contents api</pre> | Change to a file's contents via the API | "[Create or update file contents](/rest/reference/repos#create-or-update-file-contents)" in the REST API documentation |
 | <pre>merge base into head</pre> | Update of the topic branch from the base branch when the base branch requires strict status checks (via **Update branch** in a pull request, for example) | "[About protected branches](/github/administering-a-repository/about-protected-branches#require-status-checks-before-merging)" |
 | <pre>pull request branch delete button</pre> | Deletion of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" |
 | <pre>pull request branch undo button</pre> | Restoration of a topic branch from a pull request in the web interface | "[Deleting and restoring branches in a pull request](/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" |