Skip to content

relizy / listProfiles

Function: listProfiles() ​

listProfiles(config): ProfileInfo[]

Defined in: packages/relizy/src/core/profiles.ts:333

The profiles of a config (profiles): their name, description and what they change, e.g. to show them as release workflows. Works on the config of loadRelizyConfig(), or on a config file as written. The secrets a profile sets (tokens, API keys, webhook URLs) are masked in options and settings.

Parameters ​

config ​

Pick<RelizyConfig, "profiles">

Returns ​

ProfileInfo[]

Example ​

ts
const profiles = listProfiles(await loadRelizyConfig())
// [{ name: 'beta', description: '...', canary: false, settings: [{ path: 'publish.tag', value: 'beta' }] }]