Flutter版本控制插件git_changie的使用

发布于 1周前 作者 sinazl 来自 Flutter

Flutter版本控制插件git_changie的使用

git_changie 是一个强大的Dart命令行工具，旨在简化从Git提交消息生成变更日志，同时促进标准化的提交消息格式。🚀

功能 🚀

通用功能 🌟

  • 变更日志生成：自动从Git提交消息生成变更日志。
  • 输出文件定制：可以指定输出文件名（默认为 CHANGELOG.md）。
  • 备份现有变更日志：在覆盖现有变更日志之前自动创建备份。

命令行选项 📜

  • --hash：在变更日志中包含提交哈希。
  • --author：在变更日志中包含提交作者。
  • --date：在变更日志中包含提交日期。
  • --from-tag <tag>：从特定的Git标签开始生成变更日志。
  • --to-tag <tag>：生成变更日志直到特定的Git标签（包含该标签）。
  • --since <date>：从特定日期开始生成变更日志（格式：YYYY-MM-DD）。
  • --until <date>：生成变更日志直到特定日期（格式：YYYY-MM-DD）。
  • --output <file>：指定输出文件名（默认为 CHANGELOG.md）。
  • --add-category <name>：如果需要，添加自定义分类到提交消息。
  • --help：显示帮助信息及用法说明。

表情符号分类 😊

支持多种表情符号分类，以便更好地组织提交消息，包括：

  • 🎨 风格
  • ⚡️ 性能
  • 🔥 移除
  • 🐛 修复
  • 🚑 关键热修复
  • ✨ 特性
  • 📝 文档
  • 🚀 部署
  • 💄 UI 变更
  • 🎉 初始提交
  • ✅ 测试
  • 🔒️ 安全
  • 🔐 密钥
  • 🔖 发布标签
  • 🚨 警告
  • 🚧 进行中
  • 💚 CI 构建
  • ⬇️ 降级
  • ⬆️ 升级
  • 📌 锁定依赖
  • 👷 CI 系统
  • 📈 分析
  • ♻️ 重构
  • ➕ 添加依赖
  • ➖ 删除依赖
  • 🔧 配置
  • 🔨 开发脚本
  • 🌐 国际化
  • ✏️ 拼写错误
  • 💩 低质量代码
  • ⏪ 撤回
  • 🔀 合并
  • 📦 编译文件
  • 👽 API 变更
  • 🚚 移动/重命名资源
  • 📄 许可证
  • 💥 破坏性更改
  • 🍱 资产
  • 🚼 可访问性
  • 💡 注释
  • 🍻 醉酒代码
  • 💬 文本变更
  • 🗄️ 数据库变更
  • 📢 日志
  • 🙁 移除日志
  • 👥 贡献者
  • 🚸 用户体验
  • 🏗️ 架构变更
  • 📱 响应式设计
  • 🤡 模拟
  • 🥚 彩蛋
  • 🙈 .gitignore
  • 📸 快照
  • ⚗️ 实验
  • 🔍 SEO
  • 🏷️ 类型
  • 🌱 种子文件
  • 🚩 功能标志
  • 🥅 捕获错误
  • 💫 动画
  • 🗑️ 废弃代码
  • 🛂 授权
  • 🩹 小修补
  • 🧐 数据检查
  • ☮️ 移除死代码
  • 🧪 失败测试
  • 🧣 业务逻辑
  • 🩺 健康检查
  • 🧱 基础设施
  • 🧑‍💻 开发体验
  • 💸 赞助
  • 🧵 多线程
  • 🦺 验证

使用 git_changie，您可以轻松地跟踪和分类项目中的变更，使协作更加顺畅和有序！🌈

安装

从GitHub

您可以克隆仓库并在本地构建：

git clone https://github.com/Shreemanarjun/git_changie.git
cd git_changie
dart pub get

从 pub.dev 全局激活

运行：

dart pub global activate git_changie

要生成 CHANGELOG.md：

git_changie

与VS Code的Gitmoji插件集成

为了获得更美观的提交消息体验，您可以集成Visual Studio Code的Gitmoji插件。此插件提供了可选的表情符号列表，帮助您保持提交消息的一致性。

安装Gitmoji扩展的步骤如下：

  1. 打开VS Code。
  2. 转到扩展（Ctrl+Shift+X）。
  3. 搜索“Gitmoji”并安装它。
  4. 按照扩展的说明开始在您的提交消息中使用Gitmoji。

使用

可以在终端中使用 git_changie 命令并根据需要选择不同的选项来自定义输出。以下是一些常见的用法：

基本命令

要从Git提交生成变更日志：

git_changie

包含提交哈希、作者和日期

您可以将提交哈希、作者和日期包含在变更日志中：

git_changie --hash --author --date

按标签过滤

按特定标签生成变更日志：

git_changie --from-tag v1.0.0

或者直到特定标签：

git_changie --to-tag v2.0.0

按日期范围过滤

按日期范围过滤提交：

git_changie --since 2024-01-01 --until 2024-09-30

指定输出文件

指定自定义输出文件名：

git_changie --output my_changelog.md

添加自定义分类

为变更日志条目添加自定义分类：

git_changie --add-category "Custom Category"

帮助命令

获取所有选项的完整列表：

git_changie --help

更多关于Flutter版本控制插件git_changie的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter版本控制插件git_changie的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，关于Flutter版本控制插件 git_changie 的使用，下面是一个详细的代码案例展示。git_changie 是一个用于管理 Flutter 项目版本和生成 CHANGELOG.md 文件的工具。它基于 Git 提交信息自动生成版本变更日志。

1. 安装 git_changie

首先，确保你已经安装了 Dart（因为 git_changie 是用 Dart 编写的）。你可以通过以下命令全局安装 git_changie：

dart pub global activate git_changie

安装完成后，你可以通过 changie 命令来使用它。

2. 配置 .changie/config.yaml

在你的 Flutter 项目根目录下创建一个 .changie 文件夹，并在其中添加 config.yaml 文件。这个文件用于配置 git_changie 的行为。

# .changie/config.yaml
version: 1

bump:
  commit_message: "Bump version to {version}"
  major:
    keywords:
      - "BREAKING"
      - "MAJOR"
  minor:
    keywords:
      - "MINOR"
      - "FEATURE"
  patch:
    keywords:
      - "PATCH"
      - "FIX"

changelog:
  categories:
    - title: "Breaking Changes"
      labels: ["breaking"]
    - title: "New Features"
      labels: ["feature", "features"]
    - title: "Bug Fixes"
      labels: ["fix", "bug"]
    - title: "Improvements"
      labels: ["improvement", "improvements"]
    - title: "Documentation"
      labels: ["docs", "documentation"]
    - title: "Dependencies"
      labels: ["dependency", "dependencies"]
    - title: "Miscellaneous"
      labels: []

3. 标记提交

在你的 Git 提交信息中包含适当的关键词（如 feature, fix, BREAKING 等），这些关键词将决定版本号的变更类型。

例如：

git add .
git commit -m "feature: add new login feature"

4. 生成版本和 CHANGELOG

当你准备好发布新版本时，使用 changie 命令生成新版本号和更新 CHANGELOG.md 文件。

# 检查当前版本并生成下一个版本
changie next

# 输出示例:
# Current version: 1.0.0
# Next version:    1.1.0
# Bump commit:     Bump version to 1.1.0

changie next 会自动检测最近的提交并建议下一个版本号。如果确认无误，你可以继续执行：

# 创建版本提交并更新 CHANGELOG.md
changie bump

# 推送更改到远程仓库
git push --follow-tags

5. 查看生成的 CHANGELOG.md

changie 会在项目根目录下生成一个 CHANGELOG.md 文件，其中包含基于提交信息生成的版本变更日志。

示例 CHANGELOG.md

# Changelog

## [1.1.0] - 2023-10-01

### New Features

- Add new login feature ([#123](https://github.com/your-repo/issues/123))

## [1.0.0] - 2023-09-01

### Initial Release

- First stable release

总结

通过以上步骤，你已经学会了如何使用 git_changie 来管理 Flutter 项目的版本控制和生成 CHANGELOG.md 文件。这个工具极大地简化了版本管理和变更日志的生成过程，使你的项目更加规范和易于维护。

回到顶部