relizy / PublishOptions

Interface: PublishOptions

Defined in: src/types.ts:612

Extends

• 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

---

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

---

bumpResult?

optional bumpResult?: BumpResultTruthy

Defined in: src/types.ts:625

Bump result

---

config?

optional config?: ResolvedRelizyConfig

Defined in: src/types.ts:621

Use custom config

---

configName?

optional configName?: string

Defined in: src/types.ts:634

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

Default

'relizy'

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:617

Run without side effects

Default

false

---

force?

optional force?: boolean

Defined in: src/types.ts:643

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

Set log level

---

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

---

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

---

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

---

safetyCheck?

optional safetyCheck?: boolean

Defined in: src/types.ts:583

Skip safety check

Default

true

Inherited from

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

---

suffix?

optional suffix?: string

Defined in: src/types.ts:638

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

NPM token (e.g. 123456) - supported for npm, pnpm and bun (injected via .npmrc). Yarn is not supported (it uses .yarnrc.yml).

Inherited from

PublishConfig.token