常见问题解决方案：Git Release Notes 生成项目

常见问题解决方案：Git Release Notes 生成项目

git-release-notes Generate release note pages from git commit history. 项目地址: https://gitcode.com/gh_mirrors/gi/git-release-notes

一、项目基础介绍

Git Release Notes 是一个开源项目，主要用于从 Git 提交历史中生成发布说明页面。这个项目可以帮助开发者自动化生成项目更新日志，清晰地展示版本的变更和新增特性。该项目主要使用 JavaScript 作为编程语言，并且利用了 EJS 模板引擎来生成不同格式的发布说明。

二、新手常见问题及解决步骤

问题1：如何安装和使用 Git Release Notes？

解决步骤：

1. 确保你的系统中已经安装了 Node.js 和 npm。
2. 使用 npm 全局安装 Git Release Notes：

   npm install -g git-release-notes
   

3. 进入你的 Git 项目目录。
4. 运行命令 git-release-notes <since> <until> <template>，其中 <since> 和 <until> 指定提交范围，<template> 是 EJS 模板文件路径。

问题2：如何选择和使用不同的模板？

解决步骤：

1. 在项目的 templates 目录中，有几个示例模板文件，包括 markdown、html 和 html-bootstrap。
2. 使用时，指定模板文件的路径作为 git-release-notes 命令的第三个参数。

   git-release-notes v0.9.8 v0.9.9 path/to/template.ejs > changelog.md
   

3. 如果需要自定义模板，可以创建一个新的 EJS 文件，并在其中使用模板变量。

问题3：如何过滤提交信息以生成特定的发布说明？

解决步骤：

1. 使用 -t 或 --title 选项后跟正则表达式来过滤提交标题。

   git-release-notes v0.9.8 v0.9.9 --title "feat:|fix:"
   

2. 使用 -i 或 --ignore-case 选项来忽略大小写。

   git-release-notes v0.9.8 v0.9.9 --title "feat:" --ignore-case
   

3. 使用 -f 或 --file 选项指定一个 JSON 配置文件，以避免在命令行中传递所有参数。

通过遵循上述步骤，新手可以更加顺利地开始使用 Git Release Notes 生成项目发布说明。

git-release-notes Generate release note pages from git commit history. 项目地址: https://gitcode.com/gh_mirrors/gi/git-release-notes