relizy / PublishOptions

Interface: PublishOptions

Defined in: src/types.ts:509

Extends

• PublishConfig

Properties

access?

optional access?: "public" | "restricted"

Defined in: src/types.ts:478

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

Inherited from

PublishConfig.access

---

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

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

Inherited from

PublishConfig.buildCmd

---

bumpResult?

optional bumpResult?: BumpResultTruthy

Defined in: src/types.ts:522

Bump result

---

config?

optional config?: ResolvedRelizyConfig

Defined in: src/types.ts:518

Use custom config

---

configName?

optional configName?: string

Defined in: src/types.ts:531

Custom config file name (e.g. relizy.standalone for relizy.standalone.config.ts)

Default

'relizy'

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:514

Run without side effects

Default

false

---

force?

optional force?: boolean

Defined in: src/types.ts:540

Bump even if there are no commits

Default

false

---

logLevel?

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

Defined in: src/types.ts:526

Set log level

---

otp?

optional otp?: string

Defined in: src/types.ts:482

NPM OTP (e.g. 123456)

Inherited from

PublishConfig.otp

---

packageManager?

optional packageManager?: PackageManager

Defined in: src/types.ts:466

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

Inherited from

PublishConfig.packageManager

---

packages?

optional packages?: string[]

Defined in: src/types.ts:486

Glob pattern matching for packages to publish

Inherited from

PublishConfig.packages

---

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

---

registry?

optional registry?: string

Defined in: src/types.ts:470

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

Inherited from

PublishConfig.registry

---

safetyCheck?

optional safetyCheck?: boolean

Defined in: src/types.ts:499

Skip safety check

Default

true

Inherited from

PublishConfig.safetyCheck

---

safetyCheckTimeout?

optional safetyCheckTimeout?: number

Defined in: src/types.ts:506

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

---

suffix?

optional suffix?: string

Defined in: src/types.ts:535

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

---

token?

optional token?: string

Defined in: src/types.ts:494

NPM token (e.g. 123456) - only supported for pnpm and npm

Inherited from

PublishConfig.token