Skip to content

Repository script API / utils/release-fanout / collectReleaseFanout

Function: collectReleaseFanout() ​

collectReleaseFanout(options): Promise<{ paths: { actionPaths: string[]; extensionPaths: string[]; pluginPaths: string[]; toolPaths: string[]; }; releases: object[]; }>

Defined in: utils/release-fanout.mjs:40

Selects releases for this commit and routes each one to its publisher.

Parameters ​

options ​

Release state and the GitHub release lookup.

createdReleases ​

object[]

Releases returned by Release Please.

currentSha ​

string | undefined

Commit built by this workflow run.

findRelease ​

(tagName) => Promise<object | undefined>

Looks up a GitHub release by tag.

log? ​

(message) => void = console.log

Receives recovery and deferral messages.

releasedVersions ​

Record<string, string>

Latest published version by component path.

repositoryConfig ​

Record<string, object>

Release Please configuration by component path.

root ​

string

Workspace root used to find public npm packages.

toolOnly? ​

boolean = false

Whether to include only npm tool releases for an explicit recovery run.

Returns ​

Promise<{ paths: { actionPaths: string[]; extensionPaths: string[]; pluginPaths: string[]; toolPaths: string[]; }; releases: object[]; }>

Releases and publisher paths for this commit.

Throws ​

When a release has no target commit SHA or a tool-only replay finds no matching tool release.

pumpkin-plugins documentation