@142vip.release version.Interface.VersionBumpOptions

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

Interface: VersionBumpOptions

Defined in: enums/version-bump.interface.ts:5

Properties

all?

optional all: boolean

Defined in: enums/version-bump.interface.ts:47

Indicates whether the git commit should include ALL files (git commit --all) rather than just the files that were modified by versionBump().

Defaults to false.

---

changelog?

optional changelog: boolean

Defined in: enums/version-bump.interface.ts:14

是否生成CHANGELOG.md文档

---

commit?

optional commit: string | boolean

Defined in: enums/version-bump.interface.ts:26

指示是否创建 git 提交。可以设置为自定义提交消息字符串，默认是“true”

• 消息字符串中的任何 '%s' 占位符都将被替换为新版本号。
• 如果消息字符串不包含任何 '%s' 占位符，则新版本号将附加到消息中。

---

confirm?

optional confirm: boolean

Defined in: enums/version-bump.interface.ts:52

支持用户确认提示，默认：true

---

currentVersion?

optional currentVersion: string

Defined in: enums/version-bump.interface.ts:19

当前版本号

---

cwd?

optional cwd: string

Defined in: enums/version-bump.interface.ts:62

工作目录，用作查找所有文件的基础。默认：process.cwd()

---

execute?

optional execute: string

Defined in: enums/version-bump.interface.ts:73

在 bumping 之后和 commit 之前执行其他命令

---

ignoreScripts?

optional ignoreScripts: boolean

Defined in: enums/version-bump.interface.ts:68

指示是否忽略version版本脚本。默认：false

---

preid?

optional preid: string

Defined in: enums/version-bump.interface.ts:9

预发行类型（例如 “alpha”、“beta”、“next”），默认：“alpha”

---

push?

optional push: boolean

Defined in: enums/version-bump.interface.ts:39

是否推送 git commit 和 tag。默认：true

---

recursive?

optional recursive: boolean

Defined in: enums/version-bump.interface.ts:83

递归地为 monorepo 加载文件。仅在发布monorepo主模块时有效，默认false

---

scopeName?

optional scopeName: string

Defined in: enums/version-bump.interface.ts:78

monorepo模式下，指定模块名包名

---

skipGitVerify?

optional skipGitVerify: boolean

Defined in: enums/version-bump.interface.ts:57

指示是否绕过 git 提交钩子 （'git commit --no-verify'）。默认：false

---

tag?

optional tag: string | boolean

Defined in: enums/version-bump.interface.ts:34

指示是否标记 git 提交。可以设置为自定义标签字符串，默认是“true”

• 标签字符串可以是自定义字符串，例如 'v%s'
• 标签字符串中的任何 '%s' 占位符都将被替换为新版本号
• 如果标签字符串不包含任何 '%s' 占位符，则新版本号将附加到标签中