前期准备

release-it
🚀 Generic CLI tool to automate versioning and package publishing related tasks: Use release-it for version management and publish to anywhere with its versatile configuration, a powerful plugin system, and use hooks to execute any command you need to test, build, and/or publish your project. Although release-it is a generic release tool, installation requires npm.
release-it
https://www.npmjs.com/package/release-it
release-it
@release-it/keep-a-changelog
This release-it plugin maintains your CHANGELOG.md file according to the Keep A Changelog standards. The idea and initial implementation comes from @eMarek. npm install --save-dev @release-it/keep-a-changelog In release-it config: strictLatest Entry of latest version must be present in order to get correct changelog. Set this option to false if you expect latest version without logs.
@release-it/keep-a-changelog
https://www.npmjs.com/package/@release-it/keep-a-changelog
@release-it/keep-a-changelog

安装依赖

yarn add release-it @release-it/keep-a-changelog --dev

配置

TOKEN环境变量

💡
这里用的zsh，所以处理的是 .zshrc 文件
# 打开配置文件
vim ~/.zshrc

# 配置环境变量，保存退出
export KFZ_GITLAB_TOKEN="上面获取到的Token"

# 生效之
source ~/.zshrc

# 验证
echo $GITLAB_TOKEN
Environment Variables
release-it/release-it
For GitHub or GitLab releases, make sure the token is available as an environment variable. Example: In macOS or Linux, this can be added to e.g. ~/.profile, so it's available everytime the shell is used.
release-it/release-it
https://github.com/release-it/release-it/blob/HEAD/docs/environment-variables.md
release-it/release-it

.release-it.js

release-it插件的配置文件
release-it/release-it
You can't perform that action at this time. You signed in with another tab or window. You signed out in another tab or window. Reload to refresh your session. Reload to refresh your session. We use optional third-party analytics cookies to understand how you use GitHub.com so we can build better products.
release-it/release-it
https://github.com/release-it/release-it/blob/HEAD/config/release-it.json
release-it/release-it
在项目根目录创建
module.exports = {
    git: {
        changelog: 'git log --pretty=format:"* %s (%h)"',
        commit: true,
        requireCleanWorkingDir: false, // 如果本地有文件变更而不需要提交则设为false
        requireCommits: false,
        commitMessage: 'Release v${version}',
        tag: true,
        tagName: 'v${version}',
        tagAnnotation: 'v${version}',
        push: true,
        requireUpstream: true,
        requireBranch: 'master'
    },
    npm: {
        publish: false
    },
    gitlab: {
        release: true,
        releaseName: 'v${version}',
        tokenRef: 'KFZ_GITLAB_TOKEN',
        assets: []
    },
    plugins: {
        '@release-it/keep-a-changelog': {
            'filename': 'CHANGELOG.md'
        }
    }
};

package.json

"scripts": {
    "release": "release-it"
}

发布

yarn release

常用功能

skip function

# 跳过git只npm publish
release-it --no-git

# 跳过单个步骤
release-it --no-git.tag

pre-releases

alpha：v1.0.0-alpha.0 内部测试版，一般只有测试人员使用
beta：v1.0.0-beta.0 公开测试版，在 Alpha版之后推出，这个阶段的版本有可能加入新的功能
rc：v1.0.0-rc.0 最终测试版本，最终产品的候选版本，如果未出现问题则可发布成为正式版本 
# 发布alpha
$ release-it major --preRelease=alpha
v1.0.0-alpha.0

# 发布beta
$ release-it major --preRelease=beta
v1.0.0-beta.0

# 发布rc
$ release-it major --preRelease=rc
v1.0.0-rc.0

# 继续上一版本迭代
release-it --preRelease

# 发布正式版本
release-it major
 
badge