发布软件时写 Release Note 算是常规操作，但每次从头手打也有点累，可以考虑从 Git 的提交历史中自动生成。

Git 提交信息一般是三段式结构，段落之间使用空行隔开：

<subject>

// 空行

<body>

// 空行

<trailers>

subject 和 body 自不必多说，trailers 中一般是一条条键-值对构成的信息，键和值由冒号 : 分隔。比如 Git 的 Commiter: 就可以视为一条 trailer，Gerrit 代码审查通过后，也会在 Git 提交消息中添加 Reviewed-by: 和 Tested-by: 之类的 trailer。

现假设提交信息中的 trailers 包含 Type 和 Issue 字段，分别表示类别（NewFeature, BugFix 之类）和 BUG 编号（GitHub 上的 issue 编号或者内部系统的 BUG 编号）：

Fixed a crash

- blahblah

- blahblahblah

Type: BugFix

Issue: issue-120

就可以结合 git log 和 awk 生成 Rlease Note:

git log --format='%(trailers:key=Type,valueonly,separator=%x20)%x1c%s [%(trailers:key=Issue,valueonly,separator=,)]' $FROM..HEAD | awk -F "\034" '

    {

        gsub(/\[\]$/, "", $2);

        if (length($1) == 0) $1="MISC";

        if (!($1 in item_count)) item_count[$1]=0;

        items[$1, item_count[$1]]=$2;

        item_count[$1]++;

    }

    END {

        for (k in item_count) {

            print k;

            k2=k;

            gsub(/./, "-", k2);

            print k2

            for (i=0; i<item_count[k]; i++) print "* "items[k, i];

            print ""

        }

    }'

输出：

BugFix

------

* Fixed a typo

* Fixed a crash [issue-120]

NewFeature

----------

* Added some magic

选择使用 awk 处理 git log 的输出是因为 linux 跟 macOS 都带这个软件，不需要额外安装依赖。

Git 2.22.0 及以上版本才支持按键值筛选 trailers。

在 Windows 系统上，可能没有办法直接运行 .sh 文件。但是如果安装了 Windows 版本的 Git，则会带一个 Git Bash（更重要的是，也带了 awk），这样就可以在 Git Bash 中运行 .sh 文件，也可以创建一个 .cmd 文件包装一下：

@ECHO off

SETLOCAL

CALL :FIND-PATH GITEXE_PATH git.exe

IF "%GITEXE_PATH%"=="" (

    ECHO git.exe is not found on your system

    EXIT /B 2

)

CALL :GET-DIR-NAME GITEXE_DIR "%GITEXE_PATH%"

CALL :GET-DIR-NAME GITEXE_DIR "%GITEXE_DIR:~0,-1%"

@"%GITEXE_DIR%bin\bash.exe" release-note.sh %*

:FIND-PATH

SET "%~1=%~f$PATH:2"

EXIT /B

:GET-DIR-NAME

SET "%~1=%~dp2"

EXIT /B

从 Git 提交历史生成 Release Note的更多相关文章

  1. Git提交代码规范 而且规范的Git提交历史，还可以直接生成项目发版的CHANGELOG（semantic-release）

    Git提交代码规范 - 木之子梦之蝶 - 博客园 https://www.cnblogs.com/liumengdie/p/7885210.html Commit message 的格式 Git 每次 ...

  2. git提交历史不显示自己账户的问题

    其实这个问题本身也不大好描述.还是上图好了 问题就如同途中倒数第二次提交.明明就是我提交的,却不显示我的账号.个人页面也不反映这次提交.   后来发现问题所在,要想正确显示,必须要把对这个项目的邮箱设 ...

  3. 【第八篇】- Git 查看提交历史之Spring Cloud直播商城 b2b2c电子商务技术总结

    ​ Git 查看提交历史 Git 提交历史一般常用两个命令: git log 在使用 Git 提交了若干更新之后,又或者克隆了某个项目,想回顾下提交历史,我们可以使用 git log 命令查看. 针对 ...

  4. 使用".."指定git提交范围与"..."指定git提交范围的区别

    http://blog.csdn.net/hansel/article/details/8952967 使用".."(两个点)和"..."(三个点)都可以指定一 ...

  5. git查看提交历史

    git日志的查看 在使用 Git 提交了若干更新之后,又或者克隆了某个项目,想回顾下提交历史,我们可以使用 git log 命令查看. 查看日志信息: $ git log 可以用 --oneline ...

  6. git 使用详解（5）-- get log 查看提交历史【转】

    转自:http://blog.csdn.net/wh_19910525/article/details/7468549 版权声明:本文为博主原创文章,未经博主允许不得转载.   目录(?)[-] 限制 ...

  7. git log 查看 提交历史

    在提交了若干更新之后,又或者克隆了某个项目,想回顾下提交历史,可以使用 Git log 命令查看. 接下来的例子会用我专门用于演示的 simplegit 项目,运行下面的命令获取该项目源代码: git ...

  8. Git批量修改提交历史

    有些时候我们可能需要批量修改提交历史,当然了,最近一次的提交历史很简单我们可以利用 git commit --amend 来进行最近一次提交的修改,如果你此时想要更新作者提交时间等也可以在amend之 ...

  9. git log 查看 当前分支的 提交历史

    git log  查看 当前分支的 提交历史 在提交了若干更新之后,想回顾下提交历史,可以使用 git log 命令查看 默认不用任何参数的话,git log 会按提交时间列出所有的更新,最近的更新排 ...

  10. [Git]03 如何查看提交历史

     在提交了若干更新之后,又或者克隆了某个项目,想回顾下提交历史,可以使用 gitlog 命令查看. 常用命令 1.查看提交历史 $ git log 2.查看某个文件或者某个目录的递交历史 $ gi ...

随机推荐

  1. 部署CPU与GPU通用的tensorflow：Anaconda环境

      本文介绍在Anaconda环境中,下载并配置Python中机器学习.深度学习常用的新版tensorflow库的方法.   在之前的两篇文章Python TensorFlow深度学习回归代码:DNN ...

  2. cdq分治 提高篇

    优化动态规划 序列 首先要会最长上升子序列的转移,这里就不说了. 我们 \(i\) 位置的初始值为 \(a_i\),可能变成的最大值为 \(mx_i\),可能变成的最小值为 \(mn_i\). 然后如 ...

  3. CH03_布局

    第3章:布局 本章目标 理解布局的原则 理解布局的过程 理解布局的容器 掌握各类布局容器的运用 理解 WPF 中的布局 WPF 布局原则 ​ WPF 窗口只能包含单个元素.为在WPF 窗口中放置多个元 ...

  4. Linux内核信号SIGIO使用实例讲解

    一.信号 1. 基本概念 信号是在软件层次上对中断机制的一种模拟,在原理上,一个进程收到一个信号与处理器收到一个中断请求可以说是一样的.信号是异步的,一个进程不必通过任何操作来等待信号的到达,事实上, ...

  5. CF1693D--单调区间

    \(T_4\) 单调区间结题报告 题目描述 一句话题意:给定一个排列 \(a\) 算出有多少个区间 \([l , r]\) , 满足其可以划分为一个单调递增子序列和单调递减子序列,其中单调递增子序列长 ...

  6. Unable to tunnel through proxy. Proxy returns "HTTP/1.1 503 Service Unavailable"

    背景: 某日,一正常项目迁移到新的服务器 新的服务器,需要使用代理来访问之前能直接访问的接口,加完代理之后,发现无法获取数据了 报错: org.springframework.web.client.R ...

  7. 单 log 实现 区间加减，查询区间 gcd

    主要是查询,要将 log 个区间拿出来依次求 gcd,当然如果是 O(1) gcd 的话可以直接求就是了.

  8. Round #2022/12/10

    问题 D:城市大脑 题目描述 杜老师正在编写杭州城市大脑智能引擎.杭州的道路可以被抽象成为一幅无向图.每条路的初始速度都是 \(1\ m/s\).杜老师可以使用 \(1\) 块钱让任意一条路的速度提升 ...

  9. 物体检测序列之一:NMS

    IoU (Intersection over Union),交并比,是衡量物体检测模型在特定数据集上检测效果好坏的一个常用的标准,通常情况下,想要通过IoU来衡量物体检测模型好坏需要具备以下几点: 1 ...

  10. HTML – Native Dialog Modal

    前言 之前介绍 Native Form 的时候有提及过 method="dialog", 但由于它太新了, 所以没去研究. 这篇就介绍一下. Dialog 也好 Modal 也好, ...