Skip to content

syncUpstreams

Checks every entry, and opens or updates one PR per moved upstream.

A handler or verify failure still opens the PR, as a draft with the failure in its body, so a breaking upstream change is seen rather than skipped. An error in the sync itself, such as a failed API call, is reported in the entry’s result and the next entry still runs.

Import:

import { syncUpstreams } from '@mnaoumov/typescript-dev-toolkit/upstream-sync';

Signature:

function syncUpstreams(options: SyncUpstreamsOptions, dependencies: SyncDependencies): Promise<SyncResult[]>

Parameters:

Parameter Type Description
options SyncUpstreamsOptions What to sync, and how.
dependencies SyncDependencies The outside world.

Returns: Promise<SyncResult[]> — One result per entry checked.


Links to this page: