Skip to content

relizy / SyncOptions

Interface: SyncOptions ​

Defined in: packages/relizy/src/commands/sync.ts:12

The options of relizy sync

Properties ​

branches? ​

optional branches?: string[]

Defined in: packages/relizy/src/commands/sync.ts:16

The branches to merge the released branch into, instead of the rules of sync


config? ​

optional config?: ResolvedRelizyConfig

Defined in: packages/relizy/src/commands/sync.ts:31

Config already resolved by loadRelizyConfig(), used instead of loading the config file


configName? ​

optional configName?: string

Defined in: packages/relizy/src/commands/sync.ts:27


dryRun? ​

optional dryRun?: boolean

Defined in: packages/relizy/src/commands/sync.ts:25


from? ​

optional from?: string

Defined in: packages/relizy/src/commands/sync.ts:24

The released branch, the current branch by default: its remote branch is merged


logLevel? ​

optional logLevel?: RelizyLogLevel

Defined in: packages/relizy/src/commands/sync.ts:26


mode? ​

optional mode?: SyncMode

Defined in: packages/relizy/src/commands/sync.ts:20

Override of sync.mode and of the modes of its rules for this run


onProgress? ​

optional onProgress?: RelizyEventListener

Defined in: packages/relizy/src/commands/sync.ts:37

Called with each event of the run, see ReleaseOptions.onProgress


overrides? ​

optional overrides?: RelizyConfigOverrides

Defined in: packages/relizy/src/commands/sync.ts:33

Options applied over the config file, under the options of the call


profile? ​

optional profile?: string

Defined in: packages/relizy/src/commands/sync.ts:29

Profile of profiles to apply, as --profile


safetyCheck? ​

optional safetyCheck?: boolean

Defined in: packages/relizy/src/commands/sync.ts:35

Run the safety checks before merging: the branches exist, the release can push to them or open the pull requests