relizy / ReleaseOptions

Interface: ReleaseOptions

Defined in: src/types.ts:699

Extends

• ReleaseConfig.BumpConfig.ChangelogConfig.PublishConfig

Properties

access?

optional access?: "public" | "restricted"

Defined in: src/types.ts:561

NPM access level (e.g. public or restricted)

Inherited from

PublishConfig.access

---

ai?

optional ai?: boolean

Defined in: src/types.ts:762

Override AI configuration for this run true = force-enable AI, false = force-disable AI, undefined = use config

---

args?

optional args?: string[]

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:37

Inherited from

PublishConfig.args

---

buildCmd?

optional buildCmd?: string

Defined in: src/types.ts:573

Command to build your packages before publishing (e.g. pnpm build)

Inherited from

PublishConfig.buildCmd

---

canary?

optional canary?: boolean

Defined in: src/types.ts:752

Publish a canary release from the current commit

Default

false

---

capZeroMajor?

optional capZeroMajor?: boolean

Defined in: src/types.ts:282

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

true

Inherited from

BumpConfig.capZeroMajor

---

changelog?

optional changelog?: boolean

Defined in: src/types.ts:661

Generate changelog files (CHANGELOG.md)

Default

true

Inherited from

ReleaseConfig.changelog

---

clean?

optional clean?: boolean

Defined in: src/types.ts:681

Determine if the working directory is clean and if it is not clean, exit

Default

false

Inherited from

ReleaseConfig.clean

---

commit?

optional commit?: boolean

Defined in: src/types.ts:651

Commit changes and create tag

Default

true

Inherited from

ReleaseConfig.commit

---

configName?

optional configName?: string

Defined in: src/types.ts:720

Default

'relizy'

---

dependencyTypes?

optional dependencyTypes?: ("dependencies" | "peerDependencies" | "devDependencies")[]

Defined in: src/types.ts:265

Include dependencies when bumping.

Default

['dependencies']

Inherited from

BumpConfig.dependencyTypes

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:704

Run without side effects

Default

false

---

force?

optional force?: boolean

Defined in: src/types.ts:725

Bump even if there are no commits

Default

false

---

formatCmd?

optional formatCmd?: string

Defined in: src/types.ts:329

Command to format the changelog (e.g. prettier --write CHANGELOG.md).

Inherited from

ChangelogConfig.formatCmd

---

from?

optional from?: string

Defined in: src/types.ts:707

---

gitTag?

optional gitTag?: boolean

Defined in: src/types.ts:686

Create tag

Default

true

Inherited from

ReleaseConfig.gitTag

---

includeCommitBody?

optional includeCommitBody?: boolean

Defined in: src/types.ts:339

Include commit body in the changelog.

Default

true

Inherited from

ChangelogConfig.includeCommitBody

---

includePrivates?

optional includePrivates?: boolean

Defined in: src/types.ts:757

Include private packages in bump and changelog operations.

Default

false

---

logLevel?

optional logLevel?: "error" | "silent" | "warning" | "normal" | "default" | "debug" | "trace" | "verbose"

Defined in: src/types.ts:716

---

noVerify?

optional noVerify?: boolean

Defined in: src/types.ts:676

Skip git verification while committing by using --no-verify flag

Default

true

Inherited from

ReleaseConfig.noVerify

---

otp?

optional otp?: string

Defined in: src/types.ts:565

NPM OTP (e.g. 123456)

Inherited from

PublishConfig.otp

---

packageManager?

optional packageManager?: PackageManager

Defined in: src/types.ts:549

Package manager (e.g. pnpm, npm, yarn or bun)

Inherited from

PublishConfig.packageManager

---

packages?

optional packages?: string[]

Defined in: src/types.ts:569

Glob pattern matching for packages to publish

Inherited from

PublishConfig.packages

---

prComment?

optional prComment?: boolean

Defined in: src/types.ts:696

Post release announcements to social media platforms

Default

false

Inherited from

ReleaseConfig.prComment

---

preid?

optional preid?: string

Defined in: src/types.ts:255

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

Inherited from

BumpConfig.preid

---

private?

optional private?: boolean

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:39

Inherited from

PublishConfig.private

---

prNumber?

optional prNumber?: number

Defined in: src/types.ts:747

Override PR/MR number for PR comment features

---

provider?

optional provider?: GitProvider

Defined in: src/types.ts:734

Git provider (e.g. github or gitlab)

Default

'github'

---

providerRelease?

optional providerRelease?: boolean

Defined in: src/types.ts:666

Publish release to your repository (github or gitlab)

Default

true

Inherited from

ReleaseConfig.providerRelease

---

publish?

optional publish?: boolean

Defined in: src/types.ts:671

Publish release to your registry

Default

true

Inherited from

ReleaseConfig.publish

---

publishToken?

optional publishToken?: string

Defined in: src/types.ts:743

NPM token (e.g. "123456")

---

push?

optional push?: boolean

Defined in: src/types.ts:656

Push changes to your repository (commit and tag(s))

Default

true

Inherited from

ReleaseConfig.push

---

registries?

optional registries?: RegistryTarget[]

Defined in: src/types.ts:598

Additional registries to publish to, on top of registry (if set). Entries without packageFilter apply to every package (mirroring); entries with packageFilter only apply to packages matching one of the glob patterns. Fully additive: leaving this unset preserves the single-registry behavior.

Inherited from

PublishConfig.registries

---

registry?

optional registry?: string

Defined in: src/types.ts:553

NPM registry URL (e.g. https://registry.npmjs.org/)

Inherited from

PublishConfig.registry

---

rootChangelog?

optional rootChangelog?: boolean

Defined in: src/types.ts:334

Generate changelog at root level with all changes

Default

true

Inherited from

ChangelogConfig.rootChangelog

---

safetyCheck?

optional safetyCheck?: boolean

Defined in: src/types.ts:739

Skip safety check

Default

true

Overrides

PublishConfig.safetyCheck

---

safetyCheckTimeout?

optional safetyCheckTimeout?: number

Defined in: src/types.ts:590

Maximum time in milliseconds for the registry authentication safety check before it is aborted. Prevents the release from hanging indefinitely when the registry (or a proxy) never answers.

Default

15000

Inherited from

PublishConfig.safetyCheckTimeout

---

skipExistingVersions?

optional skipExistingVersions?: boolean

Defined in: src/types.ts:609

Skip a package (per registry) instead of failing when its version already exists on the registry. Makes re-running a release idempotent: a retried job whose version is already published (e.g. a canary rerun on the same commit, or a partially completed publish) succeeds and only publishes what is missing, rather than crashing on the registry's "cannot overwrite" error. When disabled (the default), that situation still fails, but with a clear error message instead of the raw registry error.

Default

false

Inherited from

PublishConfig.skipExistingVersions

---

social?

optional social?: boolean

Defined in: src/types.ts:691

Post release announcements to social media platforms

Default

false

Inherited from

ReleaseConfig.social

---

suffix?

optional suffix?: string

Defined in: src/types.ts:729

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

---

tag?

optional tag?: string

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:38

NPM tag (e.g. latest)

Inherited from

PublishConfig.tag

---

to?

optional to?: string

Defined in: src/types.ts:710

---

token?

optional token?: string

Defined in: src/types.ts:713

Overrides

PublishConfig.token

---

type?

optional type?: ReleaseType

Defined in: src/types.ts:251

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

Default

'release'

Inherited from

BumpConfig.type

---

yes?

optional yes?: boolean

Defined in: src/types.ts:270

Skip confirmation prompt about bumping packages

Default

true

Inherited from

BumpConfig.yes