---
url: https://relizy.dev/typedoc/interfaces/SyncConfig.md
---
[relizy](../index.md) / SyncConfig

# Interface: SyncConfig

Defined in: [packages/relizy/src/types.ts:305](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/types.ts#L305)

## Properties

### message?

> `optional` **message?**: `string`

Defined in: [packages/relizy/src/types.ts:331](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/types.ts#L331)

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

#### Default

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

***

### mode?

> `optional` **mode?**: [`SyncMode`](../type-aliases/SyncMode.md)

Defined in: [packages/relizy/src/types.ts:324](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/types.ts#L324)

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`](SyncRule.md)\[]

Defined in: [packages/relizy/src/types.ts:315](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/types.ts#L315)

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
[]
```
