Skip to content

API 参考 / @142vip/release-version / ReleaseVersionOperation

类: ReleaseVersionOperation ​

定义于: release-version/src/core/releasex-operation.ts:27

单次发版流程的状态机:持有选项、中间状态,并编排完整发版步骤

属性 ​

options ​

readonly options: ReleaseVersionOperationOptions

定义于: release-version/src/core/releasex-operation.ts:29

归一化后的发版选项(commit / tag / push 等)


state ​

readonly state: ReleaseVersionOperationState

定义于: release-version/src/core/releasex-operation.ts:32

发版过程中的中间状态(版本号、commit/tag 文案等)

访问器 ​

results ​

Getter 签名 ​

get results(): ReleaseVersionResults

定义于: release-version/src/core/releasex-operation.ts:53

根据当前 state 与 options 生成对外结果快照

返回 ​

ReleaseVersionResults

方法 ​

finalizeRelease() ​

finalizeRelease(): Promise<ReleaseVersionOperation>

定义于: release-version/src/core/releasex-operation.ts:101

发版收尾阶段:git commit → tag → postversion → push

返回 ​

Promise<ReleaseVersionOperation>


prepareRelease() ​

prepareRelease(): Promise<ReleaseVersionOperation>

定义于: release-version/src/core/releasex-operation.ts:84

发版准备阶段:确认 → preversion → 写版本 → CHANGELOG → execute → version 脚本

返回 ​

Promise<ReleaseVersionOperation>


printReleasePlan() ​

printReleasePlan(title?): void

定义于: release-version/src/core/releasex-operation.ts:175

打印发版计划摘要(CLI 试运行与发版前确认复用)

参数 ​

title? ​

string = '发版计划:'

返回 ​

void


resolveVersions() ​

resolveVersions(): Promise<ReleaseVersionOperation>

定义于: release-version/src/core/releasex-operation.ts:75

解析当前版本与目标版本(交互式选择新版本)

  • 不修改 package.json,不写 CHANGELOG

返回 ​

Promise<ReleaseVersionOperation>


create() ​

static create(input): Promise<ReleaseVersionOperation>

定义于: release-version/src/core/releasex-operation.ts:66

创建发版操作实例(仅归一化选项,不读写磁盘)

参数 ​

input ​

ReleaseVersionOptions

返回 ​

Promise<ReleaseVersionOperation>