relizy / ReleaseOptions

Interface: ReleaseOptions

Defined in: src/types.ts:521

Extends

• ReleaseConfig.BumpConfig.ChangelogConfig.PublishConfig

Properties

access?

optional access: "public" | "restricted"

Defined in: src/types.ts:415

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

Inherited from

PublishConfig.access

---

args?

optional args: string[]

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.1/node_modules/changelogen/dist/index.d.mts:37

Inherited from

PublishConfig.args

---

buildCmd?

optional buildCmd: string

Defined in: src/types.ts:427

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

Inherited from

PublishConfig.buildCmd

---

changelog?

optional changelog: boolean

Defined in: src/types.ts:488

Generate changelog files (CHANGELOG.md)

Default

true

Inherited from

ReleaseConfig.changelog

---

clean?

optional clean: boolean

Defined in: src/types.ts:508

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:478

Commit changes and create tag

Default

true

Inherited from

ReleaseConfig.commit

---

configName?

optional configName: string

Defined in: src/types.ts:542

Default

'relizy'

---

dependencyTypes?

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

Defined in: src/types.ts:209

Include dependencies when bumping.

Default

['dependencies']

Inherited from

BumpConfig.dependencyTypes

---

dryRun?

optional dryRun: boolean

Defined in: src/types.ts:526

Run without side effects

Default

false

---

force?

optional force: boolean

Defined in: src/types.ts:547

Bump even if there are no commits

Default

false

---

formatCmd?

optional formatCmd: string

Defined in: src/types.ts:251

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

Inherited from

ChangelogConfig.formatCmd

---

from?

optional from: string

Defined in: src/types.ts:529

---

gitTag?

optional gitTag: boolean

Defined in: src/types.ts:513

Create tag

Default

true

Inherited from

ReleaseConfig.gitTag

---

includeCommitBody?

optional includeCommitBody: boolean

Defined in: src/types.ts:261

Include commit body in the changelog.

Default

true

Inherited from

ChangelogConfig.includeCommitBody

---

logLevel?

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

Defined in: src/types.ts:538

---

noVerify?

optional noVerify: boolean

Defined in: src/types.ts:503

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:419

NPM OTP (e.g. 123456)

Inherited from

PublishConfig.otp

---

packageManager?

optional packageManager: PackageManager

Defined in: src/types.ts:403

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

Inherited from

PublishConfig.packageManager

---

packages?

optional packages: string[]

Defined in: src/types.ts:423

Glob pattern matching for packages to publish

Inherited from

PublishConfig.packages

---

preid?

optional preid: string

Defined in: src/types.ts:199

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

Inherited from

BumpConfig.preid

---

private?

optional private: boolean

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.1/node_modules/changelogen/dist/index.d.mts:39

Inherited from

PublishConfig.private

---

provider?

optional provider: GitProvider

Defined in: src/types.ts:556

Git provider (e.g. github or gitlab)

Default

'github'

---

providerRelease?

optional providerRelease: boolean

Defined in: src/types.ts:493

Publish release to your repository (github or gitlab)

Default

true

Inherited from

ReleaseConfig.providerRelease

---

publish?

optional publish: boolean

Defined in: src/types.ts:498

Publish release to your registry

Default

true

Inherited from

ReleaseConfig.publish

---

publishToken?

optional publishToken: string

Defined in: src/types.ts:565

NPM token (e.g. "123456")

---

push?

optional push: boolean

Defined in: src/types.ts:483

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

Default

true

Inherited from

ReleaseConfig.push

---

registry?

optional registry: string

Defined in: src/types.ts:407

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

Inherited from

PublishConfig.registry

---

rootChangelog?

optional rootChangelog: boolean

Defined in: src/types.ts:256

Generate changelog at root level with all changes

Default

true

Inherited from

ChangelogConfig.rootChangelog

---

safetyCheck?

optional safetyCheck: boolean

Defined in: src/types.ts:561

Skip safety check

Default

true

Overrides

PublishConfig.safetyCheck

---

social?

optional social: boolean

Defined in: src/types.ts:518

Post release announcements to social media platforms

Default

false

Inherited from

ReleaseConfig.social

---

suffix?

optional suffix: string

Defined in: src/types.ts:551

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/changelogen@0.6.2_magicast@0.5.1/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:532

---

token?

optional token: string

Defined in: src/types.ts:535

Overrides

PublishConfig.token

---

type?

optional type: ReleaseType

Defined in: src/types.ts:195

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:214

Skip confirmation prompt about bumping packages

Default

true

Inherited from

BumpConfig.yes