relizy / PublishConfig

Interface: PublishConfig

Defined in: src/types.ts:719

Extended by

• PublishOptions
• ReleaseOptions

Properties

access?

optional access?: "public" | "restricted"

Defined in: src/types.ts:744

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

---

args?

optional args?: string[]

Defined in: src/types.ts:723

Arguments passed to the publish command

---

buildCmd?

optional buildCmd?: string

Defined in: src/types.ts:756

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

---

checkWorkspaceDependencies?

optional checkWorkspaceDependencies?: boolean

Defined in: src/types.ts:803

Before publishing, check the internal dependencies declared with the workspace: protocol (workspace:*, workspace:^, workspace:~) in dependencies, peerDependencies and optionalDependencies: the version the package manager will write must be published by this run or already be on the registry. Fails when the registry confirms the version is missing (the published package could not be installed), warns when the registry cannot be queried.

Default

true

---

otp?

optional otp?: string

Defined in: src/types.ts:748

NPM OTP (e.g. 123456)

---

packageManager?

optional packageManager?: PackageManager

Defined in: src/types.ts:732

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

---

packages?

optional packages?: string[]

Defined in: src/types.ts:752

Glob pattern matching for packages to publish

---

private?

optional private?: boolean

Defined in: src/types.ts:728

Publish the private packages

Default

false

---

registries?

optional registries?: RegistryTarget[]

Defined in: src/types.ts:781

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

Defined in: src/types.ts:736

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

---

safetyCheck?

optional safetyCheck?: boolean

Defined in: src/types.ts:766

Skip safety check

Default

true

---

safetyCheckTimeout?

optional safetyCheckTimeout?: number

Defined in: src/types.ts:773

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

Defined in: src/types.ts:792

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

Defined in: src/types.ts:740

NPM tag (e.g. latest)

---

token?

optional token?: string

Defined in: src/types.ts:761

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