relizy / HookConfig

Type Alias: HookConfig

HookConfig = { [K in `${HookType}😒{HookStep}`]?: string | ((config: ResolvedRelizyConfig, dryRun: boolean) => any) } & object

Defined in: src/types.ts:1244

Hooks configuration Useful to run custom scripts before, after a step or on error

Type Declaration

generate:changelog?

optional generate:changelog?: (config, dryRun, params) => string | void | null | undefined | Promise<string | void | null | undefined>

Parameters

config

ResolvedRelizyConfig

dryRun

boolean

params

changelog

string

commits

GitCommit[]

Returns

string | void | null | undefined | Promise<string | void | null | undefined>