前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Nuxt3 实战 (三):使用 release-it 自动管理版本号和生成 CHANGELOG

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

原创
作者头像
白雾茫茫丶
发布2024-05-22 14:23:50
1380
发布2024-05-22 14:23:50
举报
文章被收录于专栏:Nuxt3 实战系列Nuxt3 实战系列

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

2、 根目录添加 .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 ,需要的朋友可自己配置

3.、向 package.jsonscripts 中添加命令:

代码语言:json
复制
"release": "release-it"

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

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

 # 更新次版本号
 pnpm release minor

 # 更新修订号
 pnpm release patch

4、在我们开发完代码后,执行 pnpm release 命令,控制太会自动帮我们打包版本号并生成 CHANGELOG

效果预览

  • git 打的标签 Tag
  • CHANGELOG

Todo

  • 安装 Nuxt UI 和配置 Typescript 类型检查

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • release-it 能做什么?
  • 前置知识
  • 安装依赖
  • 效果预览
  • Todo
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档