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

# Interface: BumpConfig

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

## Extended by

* [`BumpOptions`](BumpOptions.md)
* [`ReleaseOptions`](ReleaseOptions.md)

## Properties

### capZeroMajor?

> `optional` **capZeroMajor?**: `boolean`

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

Cap commit-detected `major` bumps to `minor` while the current version is
in the `0.x.y` range (semver §4, initial development), so a breaking change
does not graduate a `0.x` package to `1.0.0` automatically.

Set to `false` to opt out: a breaking commit then bumps `0.x.y` straight to
`1.0.0`. This only affects **commit-based** detection; explicit CLI release
types (`--major`, `--premajor`, …) are never capped. Once the package
reaches `1.x`, this option is a no-op.

#### Default

```ts
true
```

***

### clean?

> `optional` **clean?**: `boolean`

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

Check if there are any changes to commit before bumping.

#### Default

```ts
true
```

***

### dependencyTypes?

> `optional` **dependencyTypes?**: (`"dependencies"` | `"peerDependencies"` | `"devDependencies"`)\[]

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

Dependency fields whose internal dependencies bump the package (a patch):
when its published range rejects their new version, or on every bump of
them, see `dependents`.

`peerDependencies` is not included by default: a package is bumped only when
the range of its peer dependency rejects the new version, see `outOfRangePeers`.

#### Default

```ts
['dependencies']
```

***

### dependents?

> `optional` **dependents?**: `"always"` | `"out-of-range"`

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

When a package is bumped because of an internal dependency listed in one of
the `dependencyTypes` fields:

* `out-of-range`: only when the range it was published with rejects the new
  version of the dependency (`workspace:*` on every bump, `workspace:^` on a
  major, a minor in `0.x` or a prerelease). A specifier that is not a semver
  range (`catalog:`, `link:`, `npm:`...) counts as out of range. The range
  is read from its `package.json` at its last release, as for `outOfRangePeers`.
* `always`: on every bump of the dependency, e.g. for a package that
  bundles its dependency.

#### Default

```ts
'out-of-range'
```

***

### outOfRangePeers?

> `optional` **outOfRangePeers?**: `"warn"` | `"error"` | `"bump"`

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

What to do with a package that is not bumped while the range of one of its
peer dependencies, as published, does not accept the new version of that
dependency: `workspace:*` is published as the exact version, so any new
version is out of its range; `workspace:^` only on a major, or on a
prerelease (npm rejects `6.20.0-beta.0` for `^6.19.1`). Its consumers would
get peer dependency errors (npm) or warnings (pnpm).

The published range is read from the `package.json` of the package at its
last release (its last tag): a peer dependency added since then rejects
nothing (no consumer has it), a range changed since then is checked as it
was published, and a package never released has nothing out of range.

* `bump`: bump the package, so it is released with an up-to-date range: a
  patch, or a major when the dependency makes a breaking change. The packages
  outside of the release (e.g. not in the targeted `--group`) are reported
  with a warning.
* `warn`: only warn before publishing.
* `error`: fail the release before publishing.

Whatever this option, a package released while its peer dependency makes a
breaking change its published range rejects is bumped as for a breaking
commit (`capZeroMajor` applies). In `unified`/`selective` mode, a peer
dependency of another version group gives that bump to the root version.

Independent of `dependencyTypes`, which bumps the dependents on every bump
of their dependencies (or only out of range, see `dependents`).

#### Default

```ts
'bump'
```

***

### preid?

> `optional` **preid?**: `string`

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

Prerelease identifier (e.g. 'beta', 'alpha')

***

### suffix?

> `optional` **suffix?**: `string`

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

Custom suffix for prerelease versions - replace the last .X with .suffix (e.g. 1.0.0-beta.0 -> 1.0.0-beta.suffix), as `--suffix`

***

### type?

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

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

Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')

#### Default

```ts
'release'
```

***

### yes?

> `optional` **yes?**: `boolean`

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

Skip confirmation prompt about bumping packages

#### Default

```ts
false
```
