Sync a fork branch with the upstream repository

2 parameters · 1 body field

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

branchstringrequired

The name of the branch which should be updated to match upstream.

3 status codes

200The branch has been successfully synced with the upstream repository

messagestringoptional

merge_typestringoptional

Allowed:mergefast-forwardnone

base_branchstringoptional

409The branch could not be synced because of a merge conflict

422The branch could not be synced for some other reason

Error handling

A 409 is returned: The branch could not be synced because of a merge conflict. A 422 is returned: The branch could not be synced for some other reason.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.mergeUpstream.create({
  owner: "octocat",
  repo: "hello-world",
  branch: "main",
});

{
  "message": "Successfully fetched and fast-forwarded from upstream defunkt:main",
  "merge_type": "fast-forward",
  "base_branch": "defunkt:main"
}

Request

Response

Errors