UpstreamStatus
What one comparison of an entry with its upstream found.
Import:
import type { UpstreamStatus } from '@mnaoumov/typescript-dev-toolkit/upstream-sync';Signature:
export interface UpstreamStatusProperties
| Property | Type | Description |
|---|---|---|
| changedPaths | readonly string[] | The upstream paths that changed and are watched, sorted. Always empty for an npm upstream. |
| compareUrl | string | A link that shows what changed between the pin and the head. |
| entry | UpstreamEntry | |
| head | string | The commit or version the upstream is at now. |
| pin | string | The commit or version upstreams.json records. |
| state | 'current' | 'moved' | 'unwatched' | current: nothing to do. moved: a PR is due. unwatched: upstream moved, but no watched path changed. |
| truncated | boolean | Whether GitHub truncated the compare's file list, so a watched path may be missing from changedPaths. |
Links to this page: