relizy / PublishConfig

Type Alias: PublishConfig

PublishConfig = IChangelogConfig["publish"] & object

Defined in: src/types.ts:549

Type Declaration

access?

optional access?: "public" | "restricted"

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

buildCmd?

optional buildCmd?: string

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

otp?

optional otp?: string

NPM OTP (e.g. 123456)

packageManager?

optional packageManager?: PackageManager

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

packages?

optional packages?: string[]

Glob pattern matching for packages to publish

registries?

optional registries?: RegistryTarget[]

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.

registry?

optional registry?: string

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

safetyCheck?

optional safetyCheck?: boolean

Skip safety check

Default

true

safetyCheckTimeout?

optional safetyCheckTimeout?: number

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

skipExistingVersions?

optional skipExistingVersions?: boolean

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

tag?

optional tag?: string

NPM tag (e.g. latest)

token?

optional token?: string

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