auto-changelog的简单使用

news/2025/1/24 15:01:09/

auto-changelog的简单使用

自动化生成Git提交记录,CHANGELOG.md文件

github:https://github.com/cookpete/auto-changelog

安装

npm install -g auto-changelog

配置脚本

package.json文件下

"scripts": {"changelog": "auto-changelog -p --commit-url http://xxxx/xxxx/amwiki/-/commit/{id} --sort-commits date-desc --commit-limit true --ignore-commit-pattern chore --hide-empty-releases true"
}

运行脚本

npm run changelog

参考配置列表

Usage: auto-changelog [options]Options:-o, --output [file]                 # output file, default: CHANGELOG.md-c, --config [file]                 # config file location, default: .auto-changelog-t, --template [template]           # specify template to use [compact, keepachangelog, json], default: compact-r, --remote [remote]               # specify git remote to use for links, default: origin-p, --package                       # use version from package.json as latest release-v, --latest-version [version]      # use specified version as latest release-u, --unreleased                    # include section for unreleased changes-l, --commit-limit [count]          # number of commits to display per release, default: 3-b, --backfill-limit [count]        # number of commits to backfill empty releases with, default: 3--commit-url [url]              # override url for commits, use {id} for commit id--issue-url [url]               # override url for issues, use {id} for issue id--merge-url [url]               # override url for merges, use {id} for merge id--compare-url [url]             # override url for compares, use {from} and {to} for tags--issue-pattern [regex]         # override regex pattern for issues in commit messages--breaking-pattern [regex]      # regex pattern for breaking change commits--merge-pattern [regex]         # add custom regex pattern for merge commits--commit-pattern [regex]        # pattern to include when parsing commits--ignore-commit-pattern [regex] # pattern to ignore when parsing commits--tag-pattern [regex]           # override regex pattern for version tags--tag-prefix [prefix]           # prefix used in version tags, default: v--starting-version [tag]        # specify earliest version to include in changelog--starting-date [yyyy-mm-dd]    # specify earliest date to include in changelog--ending-version [tag]          # specify latest version to include in changelog--sort-commits [property]       # sort commits by property [relevance, date, date-desc, subject, subject-desc], default: relevance--release-summary               # display tagged commit message body as release summary--unreleased-only               # only output unreleased changes--hide-empty-releases           # hide empty releases--hide-credit                   # hide auto-changelog credit--handlebars-setup [file]       # handlebars setup file--append-git-log [string]       # string to append to git log command--append-git-tag [string]       # string to append to git tag command--prepend                       # prepend changelog to output file--stdout                        # output changelog to stdout--plugins [...name]             # use plugins to augment commit/merge/release information-V, --version                       # output the version number-h, --help                          # output usage information# Write log to CHANGELOG.md in current directory
auto-changelog# Write log to HISTORY.md using keepachangelog template
auto-changelog --output HISTORY.md --template keepachangelog# Disable the commit limit, rendering all commits for every release
auto-changelog --commit-limit false

配置示例

当前配置

"changelog": "auto-changelog -p --commit-url http://192.168.217.8/xxxx/xxxx/-/commit/{id} --sort-commits date-desc --commit-limit true --ignore-commit-pattern chore --hide-empty-releases true"

命令配置解释:

-p:根据package发布版本进行分类

–commit-url http://192.168.217.8/xxxx/xxxx/-/commit/{id}:提交commit地址,动态拼接commitid

–sort-commits date-desc:根据commit时间降序

–commit-limit true:限制每次release展示的commit数量

–ignore-commit-pattern chore:忽略指定commit提交,此处忽略commit信息以chore开头的commit

–hide-empty-releases true:隐藏空的release

注意:配置与配置之间有空格

生成md文件示例

上面配置示例实际生成的md文件如下

默认生成示例

自定义模板

支持用自定义模板生成md文件

  1. 新建一个模板文件如:changelog-template.hbs

  2. 模板文件入填入代码,使用handlebars模板引擎

    # 更新日志
    {{#each releases}}
    ## {{isoDate}}{{#each merges}}
    - A merge has a {{message}}, an {{id}} and a {{href}} to the PR.{{/each}}{{#each fixes}}
    - Each fix has a {{commit}} with a {{commit.subject}}, an {{id}} and a {{href}} to the fixed issue.{{/each}}{{#each commits}}
    - {{subject}}[{{shorthash}}]({{href}}){{!-- 这里需要有个换行 否则二级标题会被渲染进li中 --}}{{/each}}
    {{/each}}
    
  3. 修改package.json文件中的脚本,以提供的模板生成内容。

    1. 模板文件changelog-template.hbs放在项目根目录,与package.json同级即可
    2. -o ./library/home-首页.md 指定输出文件目录
    "scripts": {"changelog-template": "auto-changelog --template changelog-template.hbs -o ./library/home-首页.md -p --sort-commits date-desc --commit-limit false --ignore-commit-pattern chore --hide-empty-releases true"
    },
    
  4. 运行命令后,即可按照我们的模板生成内容

模板修改

  1. 模板中的这些变量啥意思?源码数据文件->
    数据源示例

  2. 更个性化一点的修改,渲染自己想要的数据。

    找到auto-changelog源码包中的template.js文件,路径为node_modules\auto-changelog\src\template.js

    compileTemplate函数中调用自己的函数:

    const compileTemplate = async (releases, options) => {const { template, handlebarsSetup } = optionsif (handlebarsSetup) {const path = /^\//.test(handlebarsSetup) ? handlebarsSetup : join(process.cwd(), handlebarsSetup)const setup = require(path)if (typeof setup === 'function') {setup(Handlebars)}}//渲染之前调用,修改源数据customDate(releases)const compile = Handlebars.compile(await getTemplate(template), COMPILE_OPTIONS)if (template === 'json') {return compile({ releases, options })}return cleanTemplate(compile({ releases, options }))
    };//自定义函数
    function customDate(releases) {// 存放已经出现过的时间  进行去重操作let Time=[];    releases.forEach(item1 => {item1.commits.forEach((item2,index2)=>{// 遍历当前release下的所有commitif(Time.indexOf(item2.niceDate)==-1){Time.push(item2.niceDate);//没有出现过 可以显示item2.showTime=true;let date=new Date(item2.date).toLocaleDateString();item2.isoDate=date.replace(/\//g,"-");}else{// 出现过item2.showTime=false;}})});
    }
    
  3. 修改模板文件

    # 更新日志
    {{#each releases}}
    {{!-- ## {{isoDate}} --}}{{#each merges}}
    - A merge has a {{message}}, an {{id}} and a {{href}} to the PR.{{/each}}{{#each fixes}}
    - Each fix has a {{commit}} with a {{commit.subject}}, an {{id}} and a {{href}} to the fixed issue.{{/each}}{{#each commits}}{{#if showTime}}### {{isoDate}}{{/if}}
    - {{subject}}[{{shorthash}}]({{href}})
    {{!-- 这里需要有个换行 否则二级标题会被渲染进li中 --}}{{/each}}
    {{/each}}
    
  4. 这里实现的效果是输出每天的提交记录:
    生成示例

文章来源:https://blog.csdn.net/iTaylorfan/article/details/132128236
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.ppmy.cn/news/1010048.html

相关文章

webpack基础知识六:说说webpack的热更新是如何做到的?原理是什么?

一、是什么 HMR全称 Hot Module Replacement,可以理解为模块热替换,指在应用程序运行过程中,替换、添加、删除模块,而无需重新刷新整个应用 例如,我们在应用运行过程中修改了某个模块,通过自动刷新会导致…

-bash: ./startup.sh: Permission denied解决

今天在Linux上启动Tomcat,结果弹出:-bash: ./startup.sh: Permission denied 的提示。 这是因为用户没有权限,而导致无法执行。用命令chmod 修改一下bin目录下的.sh权限就可以了。 在Tomcat的bin目录下 ,输入命令行 :c…

03_010物理内存ram分配器,内存区域页分配及水位线等分析

memblock分配器 系统初始化的时候需要执行一些内存管理 内存分配任务就会需要内存管理器 内核初始化时候memblock分配器 先说说这个memblock分配器 有三个重要的结构体 struct memblock 表示这个分配器 内核初始化的时候 有个全局变量struct memblock 因为一个物理内存(节点…

在家下载Springer、IEEE、ScienceDirect等数据库论文的论文下载工具

Springer、IEEE、ScienceDirec数据库是我们查找外文文献常用数据库,当我们没有数据库使用权限的时该如何下载这些数据库的学术论文呢?下面就讲解一下在家下载数据库学术文献的论文下载工具。 一、查找下载外文文献,我们可以谷歌学术检索&…

Docker Compose 使用方法

目录 前言 安装 Docker Compose Ubuntu 安装与更新 Red Hat 安装与更新 验证是否安装 Docker Compose 创建 docker-compose.yml 文件 创建一个MySQL 与 tomcat 示例 使用Docker Compose启动服务 前言 Docker Compose 是一个工具,旨在帮助定义和 共享多容器…

C++拷贝wstring到wchar_t*中踩的坑

使用wchar_t指针将wstring中的数据拿出来,发现释放的时候异常,不是深拷贝和浅拷贝的问题 首先先看看string怎末复制到char中,代码如下 string str1"\"0.2.0\"";char* tnew char[str.size()1];memcpy(t, str1.c_str(), s…

Spring(九) - 解惑 spring 嵌套事务.2

1. 事务传播特性 在所有使用 spring 的应用中, 声明式事务管理可能是使用率最高的功能了, 但是, 从我观察到的情况看,绝大多数人并不能深刻理解事务声明中不同事务传播属性配置的的含义, 让我们来看一下 TransactionDefinition 接口中的定义 Java代码 /** * Support a cu…

如何使用本地mock数据

当后端同事接口数据还未完成,我们前端开发需要使用数据时,怎么办呢?这里可以自己本地mock数据先用着啦!仅在开发时使用 1. 创建一个 xxx.js文件,对外暴露一个数组; 对新建js文件编写导出,返回数…