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

# Interface: SyncRule

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

Where the releases of a branch are merged

## Properties

### from

> **from**: `string`

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

The released branch: a name (`main`) or a glob (`release/*`, `*` stops at
`/`, `**` does not)

***

### message?

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

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

Override of `sync.message` for this rule

***

### mode?

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

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

Override of `sync.mode` for this rule

***

### to

> **to**: `string`\[]

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

The branches a release of `from` is merged into, by name, e.g. `['develop']`
