dependabit / github-client/src / ReleaseManager

Class: ReleaseManager

Defined in: packages/github-client/src/releases.ts:23

Constructors

Constructor

new ReleaseManager(auth?): ReleaseManager;

Defined in: packages/github-client/src/releases.ts:26

Parameters

Parameter	Type
auth?	string

Returns

ReleaseManager

Methods

compareReleases()

compareReleases(oldReleases, newReleases): ReleaseComparison;

Defined in: packages/github-client/src/releases.ts:100

Compares two sets of releases to find new ones

Parameters

Parameter	Type
oldReleases	Release[]
newReleases	Release[]

Returns

ReleaseComparison

---

getAllReleases()

getAllReleases(params): Promise<Release[]>;

Defined in: packages/github-client/src/releases.ts:64

Fetches all releases from a repository

Parameters

Parameter	Type
params	{ owner: string; page?: number; perPage?: number; repo: string; }
params.owner	string
params.page?	number
params.perPage?	number
params.repo	string

Returns

Promise<Release[]>

---

getLatestRelease()

getLatestRelease(params): Promise<Release | null>;

Defined in: packages/github-client/src/releases.ts:35

Fetches the latest release from a repository

Parameters

Parameter	Type
params	{ owner: string; repo: string; }
params.owner	string
params.repo	string

Returns

Promise<Release | null>

---

getReleaseByTag()

getReleaseByTag(params): Promise<Release | null>;

Defined in: packages/github-client/src/releases.ts:119

Fetches release notes for a specific tag

Parameters

Parameter	Type
params	{ owner: string; repo: string; tag: string; }
params.owner	string
params.repo	string
params.tag	string

Returns

Promise<Release | null>