Nuxt3 实战 (三):使用 release-it 自动管理版本号和生成 CHANGELOG

release-it 能做什么?

  1. 增加版本号并提交 Git
  2. 生成变更日志(Changelog)并提交到 Git
  3. 创建 Git 标签并推送到远程仓库
  4. 发布到 npm 等软件仓库
  5. GitHubGitLab 等平台创建发行版

前置知识

在看这篇文章之前,我们有必要了解一下 SemVer规范

安装依赖

  1. 执行命令
powershell 复制代码
pnpm add release-it @release-it/conventional-changelog -D
  1. 根目录添加 .release-it.json 配置文件,具体配置请参考:conventional-changelog
json 复制代码
  {
   "plugins": {
     "@release-it/conventional-changelog": {
       "preset": {
         "name": "conventionalcommits",
         "types": [
           { "type": "feat", "section": "✨ Features | 新功能" },
           { "type": "fix", "section": "🐛 Bug Fixes | Bug 修复" },
           { "type": "chore", "section": "🎫 Chores | 其他更新" },
           { "type": "docs", "section": "📝 Documentation | 文档" },
           { "type": "style", "section": "💄 Styles | 风格" },
           { "type": "refactor", "section": "♻ Code Refactoring | 代码重构" },
           { "type": "perf", "section": "⚡ Performance Improvements | 性能优化" },
           { "type": "test", "section": "✅ Tests | 测试" },
           { "type": "revert", "section": "⏪ Reverts | 回退" },
           { "type": "build", "section": "👷‍ Build System | 构建" },
           { "type": "ci", "section": "🔧 Continuous Integration | CI 配置" },
           { "type": "config", "section": "🔨 CONFIG | 配置" }
         ]
       },
       "infile": "CHANGELOG.md",
       "ignoreRecommendedBump": true,
       "strictSemVer": true
     }
   },
   "git": {
     "commitMessage": "chore: Release v${version}"
   },
   "github": {
     "release": true,
     "draft": false
   }
 }

配置说明:

  • git:配置 Git 相关的任务,如自动提交代码、打标签等
  • github:配置 GitHub 相关的任务,如创建发行版
  • npm:配置 npm 相关的任务,如发布到 npm 仓库
  • plugins:配置使用的插件

本文并没有发布到 npm ,需要的朋友可自己配置

  1. package.jsonscripts 中添加命令:
json 复制代码
"release": "release-it"

上面命令默认更新次版本号,如果想每次更新修订号,可执行 pnpm release patch

powershell 复制代码
# 更新主版本号
pnpm release major

# 更新次版本号
pnpm release minor

# 更新修订号
pnpm release patch
  1. 在我们开发完代码后,执行 pnpm release 命令,控制太会自动帮我们打包版本号并生成 CHANGELOG

效果预览

  • git 打的标签 Tag
  • CHANGELOG

Todo

相关推荐
codingWhat1 小时前
介绍一个手势识别库——AlloyFinger
前端·javascript·vue.js
踩着两条虫1 小时前
VTJ.PRO 双向代码转换原理揭秘
前端·vue.js·人工智能
SuperEugene5 小时前
Vue生态精选篇:Element Plus 的“企业后台常用组件”用法扫盲
前端·vue.js·面试
bluceli9 小时前
Vue 3 Composition API深度解析:构建可复用逻辑的终极方案
前端·vue.js
程序员ys9 小时前
前端权限控制设计
前端·vue.js·react.js
滕青山9 小时前
腾讯域名拦截查询 在线工具核心JS实现
前端·javascript·vue.js
wuhen_n12 小时前
TypeScript 强力护航:PropType 与组件事件类型的声明
前端·javascript·vue.js
wuhen_n12 小时前
组件设计原则:如何设计一个高内聚、低耦合的 Vue 组件
前端·javascript·vue.js
独泪了无痕1 天前
Vue调试神器:Vue DevTools使用指南
vue.js·前端工程化
优秀稳妥的JiaJi1 天前
基于腾讯地图实现电子围栏绘制与校验
前端·vue.js·前端框架