feat: .rest.repos.mergeUpstream({ owner, repo, branch }) (#439)

Author: octokitbot

docs/repos/mergeUpstream.md

@@ -0,0 +1,46 @@
+---
+name: Sync a fork branch with the upstream repository
+example: octokit.rest.repos.mergeUpstream({ owner, repo, branch })
+route: POST /repos/{owner}/{repo}/merge-upstream
+scope: repos
+type: API method
+---
+
+# Sync a fork branch with the upstream repository
+
+Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
+
+```js
+octokit.rest.repos.mergeUpstream({
+  owner,
+  repo,
+  branch,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+</td></tr>
+<tr><td>branch</td><td>yes</td><td>
+
+The name of the branch which should be updated to match upstream.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository).

package-lock.json

@@ -24,7 +24,7 @@
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/types": "^6.26.0",
+    "@octokit/types": "^6.27.0",
     "deprecation": "^2.3.1"
   },
   "devDependencies": {

package.json

@@ -44684,6 +44684,82 @@
     ],
     "renamed": null
   },
+  {
+    "name": "Sync a fork branch with the upstream repository",
+    "scope": "repos",
+    "id": "mergeUpstream",
+    "method": "POST",
+    "url": "/repos/{owner}/{repo}/merge-upstream",
+    "isDeprecated": false,
+    "deprecationDate": null,
+    "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
+    "documentationUrl": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository",
+    "previews": [],
+    "headers": [],
+    "parameters": [
+      {
+        "name": "owner",
+        "description": "",
+        "in": "PATH",
+        "type": "string",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      },
+      {
+        "name": "repo",
+        "description": "",
+        "in": "PATH",
+        "type": "string",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      },
+      {
+        "name": "branch",
+        "description": "The name of the branch which should be updated to match upstream.",
+        "in": "BODY",
+        "type": "string",
+        "required": true,
+        "enum": null,
+        "allowNull": false,
+        "mapToData": null,
+        "validation": null,
+        "alias": null,
+        "deprecated": null
+      }
+    ],
+    "responses": [
+      {
+        "code": 200,
+        "description": "The branch has been successfully synced with the upstream repository",
+        "examples": [
+          {
+            "data": "{\"message\":\"Successfully fetched and fast-forwarded from upstream defunkt:main\",\"merge_type\":\"fast-forward\",\"base_branch\":\"defunkt:main\"}"
+          }
+        ]
+      },
+      {
+        "code": 409,
+        "description": "The branch could not be synced because of a merge conflict",
+        "examples": null
+      },
+      {
+        "code": 422,
+        "description": "The branch could not be synced for some other reason",
+        "examples": null
+      }
+    ],
+    "renamed": null
+  },
   {
     "name": "Ping a repository webhook",
     "scope": "repos",

scripts/update-endpoints/generated/endpoints.json

@@ -1238,6 +1238,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
     ],
     listWebhooks: ["GET /repos/{owner}/{repo}/hooks"],
     merge: ["POST /repos/{owner}/{repo}/merges"],
+    mergeUpstream: ["POST /repos/{owner}/{repo}/merge-upstream"],
     pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"],
     redeliverWebhookDelivery: [
       "POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",

src/generated/endpoints.ts

@@ -7800,6 +7800,16 @@ export type RestEndpointMethods = {
       defaults: RequestInterface["defaults"];
       endpoint: EndpointInterface<{ url: string }>;
     };
+    /**
+     * Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
+     */
+    mergeUpstream: {
+      (
+        params?: RestEndpointMethodTypes["repos"]["mergeUpstream"]["parameters"]
+      ): Promise<RestEndpointMethodTypes["repos"]["mergeUpstream"]["response"]>;
+      defaults: RequestInterface["defaults"];
+      endpoint: EndpointInterface<{ url: string }>;
+    };
     /**
      * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
      */

src/generated/method-types.ts

@@ -4570,6 +4570,14 @@ export type RestEndpointMethodTypes = {
         >;
       response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"];
     };
+    mergeUpstream: {
+      parameters: RequestParameters &
+        Omit<
+          Endpoints["POST /repos/{owner}/{repo}/merge-upstream"]["parameters"],
+          "baseUrl" | "headers" | "mediaType"
+        >;
+      response: Endpoints["POST /repos/{owner}/{repo}/merge-upstream"]["response"];
+    };
     pingWebhook: {
       parameters: RequestParameters &
         Omit<