Skip to content

relizy / SyncConfig

Interface: SyncConfig ​

Defined in: packages/relizy/src/types.ts:305

Properties ​

message? ​

optional message?: string

Defined in: packages/relizy/src/types.ts:331

Message of the merge commit (push), title of the pull request (pull-request), unless their rule sets it. Available variables: (the released branch), (the branch merged into), (the tags of the release, comma-separated)

Default ​

ts
'chore(release): sync {{target}} with {{source}}'

mode? ​

optional mode?: SyncMode

Defined in: packages/relizy/src/types.ts:324

How the branches get the release, unless their rule sets it. push: merge the released branch into each branch and push it (a fast-forward when the branch has nothing of its own), nothing is pushed on a conflict. pull-request: open a pull request (merge request on GitLab) from the released branch into each branch, or reuse the open one, for protected branches

Default ​

ts
'push'

rules? ​

optional rules?: SyncRule[]

Defined in: packages/relizy/src/types.ts:315

Where each released branch is merged after the release (relizy release, once the release commit is pushed) or with relizy sync: the rules whose from matches the released branch give the branches to merge it into, e.g. [{ from: 'main', to: ['develop'] }]. A release of a branch that no rule matches (a beta of develop, a canary of a feature branch) syncs nothing. The released branch is never merged into itself.

Default ​

ts
[]