relizy / PreviewPackage
Interface: PreviewPackage
Defined in: packages/relizy/src/core/release-preview.ts:41
Properties
breakingPeerDependency?
optionalbreakingPeerDependency?:string
Defined in: packages/relizy/src/core/release-preview.ts:68
A peer dependency making a breaking change that the published range of the package rejects
bump
bump:
PreviewBumpType
Defined in: packages/relizy/src/core/release-preview.ts:49
major, minor... computed from the two versions
commits
commits:
PreviewCommit[]
Defined in: packages/relizy/src/core/release-preview.ts:57
dependency?
optionaldependency?:object
Defined in: packages/relizy/src/core/release-preview.ts:59
Set for the dependency reason
chain
chain:
string[]
The dependencies leading to the one that bumps it, the first one released by commits last
group?
optionalgroup?:string
The version group releasing the dependency, when it is another one
outOfRange?
optionaloutOfRange?:object
The new version of the dependency is out of the published range of the package: the range, the field and the new version
outOfRange.field
field:
"dependencies"|"peerDependencies"|"devDependencies"
outOfRange.name
name:
string
outOfRange.newVersion
newVersion:
string
outOfRange.range
range:
string|null
name
name:
string
Defined in: packages/relizy/src/core/release-preview.ts:42
newVersion
newVersion:
string
Defined in: packages/relizy/src/core/release-preview.ts:47
oldVersion
oldVersion:
string
Defined in: packages/relizy/src/core/release-preview.ts:46
path
path:
string
Defined in: packages/relizy/src/core/release-preview.ts:44
Directory of the package, relative to the project (. for the root)
private
private:
boolean
Defined in: packages/relizy/src/core/release-preview.ts:45
reason
reason:
"commits"|"dependency"|"graduation"|"unified"|"forced"
Defined in: packages/relizy/src/core/release-preview.ts:56
Why it is released: its commits, a bumped dependency (see dependency), the graduation of its prerelease, forced (force), or the unified version it follows
tag?
optionaltag?:string
Defined in: packages/relizy/src/core/release-preview.ts:51
The release tag of the package: its own tag in an independent group, the one of the repository otherwise