Repository script API / register-public-tool / registerPublicTool

Function: registerPublicTool()

registerPublicTool(root, toolDirectory): object

Defined in: register-public-tool.mjs:17

Registers an existing public tool in Release Please's config and version manifest.

Parameters

root

string

Repository root containing the tool and both Release Please files.

toolDirectory

string

Workspace path under tools/, for example tools/codemod or tools/apis/pumpkin-pie-api.

Returns

object

Which files were updated.

configChanged

configChanged: boolean

manifestChanged

manifestChanged: boolean

Throws

If the tool path, package, version or existing release registration is invalid.