27 lines
2.5 KiB
Markdown
27 lines
2.5 KiB
Markdown
# Changesets
|
||
|
||
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
||
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
||
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
||
|
||
We have a quick list of common questions to get you started engaging with this project in
|
||
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
||
|
||
|
||
## config.json
|
||
|
||
- commit：类型为布尔值，默认值为false。当将此字段配置为true时，在执行change和bump命令时，将自动执行提交代码操作。
|
||
- access：类型为restricted | public，默认值为restricted。用于配置当前包的发布形式，如果配置为restricted，则作为私有包发布，如果为public，则发布公共范围包。
|
||
- baseBranch：类型为字符串，默认值为main。仓库主分支。该配置用于计算当前分支的变更包并进行分类。
|
||
- ignore：类型为字符串数组，默认值为空数组。用于声明执行bump命令时忽略的包，与bump命令的–ignore参数用法一致，注意两者不能同时使用。
|
||
- fixed：类型为字符串数组数组，默认值为空数组。用于在monorepo中对包进行分组，相同分组中的包版本号将进行绑定，每次执行bump命令时，同一分组中的包只要有一个升级版本号，其他会一起升级。支持使用正则匹配包名称。
|
||
- linked：类型为字符串数组数组，默认值为空数组。与fixed类似，也是对monorepo中对包进行分组，但是每次执行bump命令时，只有和changeset声明的变更相关的包才会升级版本号，同一分组的变更包的版本号将保持一致。支持使用正则匹配包名称。
|
||
- updateInternalDependencies：类型为patch | minor，默认值为patch。用于声明更新内部依赖的版本号规则。当执行bump命令升级版本号时，默认会自动更新仓库中使用该包的依赖声明。
|
||
- changelog：类型为布尔值 | 字符串 | [字符串, unknow]，默认值为@changesets/cli/changelog。生成Changelog规则。
|
||
|
||
## bump
|
||
|
||
MAJOR（主要）版本：当你做出不兼容的 API 更改时，需要增加`主版本`号。
|
||
MINOR（次要）版本：当你以向后兼容的方式引入新功能时，需要增加`次版本`号。
|
||
PATCH（补丁）版本：当你进行向后兼容的错误修复时，需要增加补丁版本号。
|