Generate git-log as Markdown Format

将 Git 提交日志以 Markdown 格式输出。

使用方法

$ chmod +x changelog.sh
$ copy changelog.sh /usr/local/bin
$ changelog.sh -v
v1.0.5

详细的使用方法请使用 --help 选项查看：

$ changelog.sh --help

USAGE
    changelog.sh [--since [VERSION]] [--until [VERSION]]

Format git-log message as plain text or markdown table.

OPTIONS
    -f|--format     Output format: text|markdown
    -h|--help)      Print help
    -v|--version)   Print version info
    -p|--prefix)    If provided, search all sub-folders with this prefix.
                    Otherwise process current directory.
    -s|--since)     Commit id from
    -u|--until)     Commit id to
EXAMPLES
    1. Generate all change logs between 1.0.1 and 1.0.2

        $ changelog.sh --since 1.0.1 --until 1.0.2

    2. Generate all change logs of version 1.0.2 from the very beginning

        $ changelog.sh --until 1.0.2

    3. Generate all change logs since version 1.0.2

        $ changelog.sh --since 1.0.2

用例

1. 生成 Markdown 格式文件

$ changelog.sh --until v1.0.0
[INFO] CHANGELOG will be written to file CHANGELOG-v1.0.0.md

打开 CHANGELOG-v1.0.0.md 之后效果如下（以 devbox 项目为例）：

git log --no-merges --format="%h %ad %an %s" --date=short v1.0.0

CHANGELOG FOR devbox

---

COMMIT ID	COMMIT DATE	AUTHOR	COMMIT MSG.
46d29ed	2023-11-20	eliu	Change vagrant box to bento/centos-7
9802713	2023-11-20	eliu	Fix error: Unknown configuration section 'vbguest'
0f01240	2023-11-17	eliu	前端工具以单独的置备器提供
ad61b8b	2023-11-16	eliu	解决各种兼容性问题
878a050	2021-03-09	eliu	add LICENSE.
095d3b3	2021-03-09	eliu	first commit

2. 打印到标准输出设备

额外提供格式选项 --format 为 text，脚本就会将格式化后的变更日志结果写入标准输出设备（/dev/stdout）

$ changelog.sh --since v1.0.0 --format text
[INFO] Validating parameters...
[INFO] Changelog will be written to file /dev/stdout
### changelog for git repo: devbox ###

COMMIT ID  DATE        AUTHOR  COMMIT MSG.
8c74dce    2023-11-23  eliu    Update project full name in README
bd75115    2023-11-23  eliu    reduce the output controlled by DEBUG
74140d1    2023-11-23  eliu    rename the rest of the folder
646fb08    2023-11-23  eliu    Refactor file name style
d107e7a    2023-11-22  eliu    upgrade the image version of minio
ececf17    2023-11-22  eliu    refactor the whole project structure and other optimizations
a61f483    2023-11-21  eliu    adaption to rocky linux

Powershell 支持

目前已经可以很好的支持 Powershell. Powershell 下是以 Module 的形式发布的，模块具体的安装方式如下：

0x01. 复制 PSGitLogMarkdown 目录到 Powershell 的模块目录下：

# macOS 和 Linux 下
$HOME/.local/share/powershell/Modules
# Windows 下
$HOME\Documents\Powershell\Modules

0x02. 解除默认脚本执行限制

执行以下脚本检查当前用户执行脚本的策略：

PS > Get-ExecutionPolicy -Scope CurrentUser

如果返回结果是 Unrestricted 则无需额外操作，如果是 Undefined 或者 RemoteSigned 之类的，则需要以管理员职责运行 Powershell 并运行以下命令解除限制：

PS > Set-ExecutionPolicy Unrestricted -Scope CurrentUser
PS > Unblock-File $HOME\Documents\Powershell\Modules\PSGitLogMarkdown\PSModule.psm1

0x03. 导入模块

Import-Module PSGitLogMarkdown

0x04. 使用 Get-Help 命令确认模块是否已成功安装

PS > Get-Help ConvertFrom-GitLog

NAME
    ConvertFrom-GitLog

SYNOPSIS
    ConvertFrom-GitLog convert git-log to markdown format.


SYNTAX
    ConvertFrom-GitLog [[-Since] <String>] [[-Until] <String>] [[-Format] <Object>] [<CommonParameters>]


DESCRIPTION


RELATED LINKS

REMARKS
    To see the examples, type: "Get-Help ConvertFrom-GitLog -Examples"
    For more information, type: "Get-Help ConvertFrom-GitLog -Detailed"
    For technical information, type: "Get-Help ConvertFrom-GitLog -Full"

之后就可以根据帮助文件和 Examples 来生成 Git 日志到指定格式了。

创作灵感

如何生成 Markdown 格式的 Git 日志 | 楓の葉 (eliu.github.io)

许可

Apache-2.0