relizy / PublishConfig
Interface: PublishConfig
Defined in: packages/relizy/src/types.ts:673
Extended by
Properties
access?
optionalaccess?:"public"|"restricted"
Defined in: packages/relizy/src/types.ts:697
NPM access level (e.g. public or restricted)
args?
optionalargs?:string[]
Defined in: packages/relizy/src/types.ts:679
Extra arguments of the publish command of every package and registry, after the ones of relizy (e.g. ['--provenance'])
Default
[]buildCmd?
optionalbuildCmd?:string
Defined in: packages/relizy/src/types.ts:705
Command to build your packages before publishing (e.g. pnpm build)
checkWorkspaceDependencies?
optionalcheckWorkspaceDependencies?:boolean
Defined in: packages/relizy/src/types.ts:747
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
trueotp?
optionalotp?:string
Defined in: packages/relizy/src/types.ts:701
NPM OTP (e.g. 123456)
packageManager?
optionalpackageManager?:PackageManager
Defined in: packages/relizy/src/types.ts:683
Package manager (e.g. pnpm, npm, yarn or bun)
registries?
optionalregistries?:RegistryTarget[]
Defined in: packages/relizy/src/types.ts:725
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. Without registry, only these registries are used: a package that no entry covers goes to the registry of the npm config.
registry?
optionalregistry?:string
Defined in: packages/relizy/src/types.ts:689
NPM registry URL (e.g. https://registry.npmjs.org/). Without it, the registry of the npm config (.npmrc), unless registries is set: the packages then go only to the declared registries
safetyCheck?
optionalsafetyCheck?:boolean
Defined in: packages/relizy/src/types.ts:710
Authenticate to each registry the packages need (whoami) before publishing
Default
truesafetyCheckTimeout?
optionalsafetyCheckTimeout?:number
Defined in: packages/relizy/src/types.ts:717
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
15000skipExistingVersions?
optionalskipExistingVersions?:boolean
Defined in: packages/relizy/src/types.ts:736
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
falsetag?
optionaltag?:string
Defined in: packages/relizy/src/types.ts:693
NPM tag (e.g. latest)