auto-changelog 开源项目安装与使用指南

auto-changelog 开源项目安装与使用指南

auto-changelogCommand line tool for generating a changelog from git tags and commit history项目地址:https://gitcode.com/gh_mirrors/au/auto-changelog

目录结构及介绍

auto-changelog 是一个用于自动生成变更日志（Changelog）的命令行工具，基于 Git 标签和提交历史。以下是从克隆仓库得到的基本目录结构：

auto-changelog/
├── scripts/
│   └── ... # 脚本文件，如自动化脚本或辅助工具
└── src/
    └── ... # 源代码文件，实现主要功能的部分
└── templates/
    └── ... # 变更日志模板文件
└── tests/
    └── ... # 测试相关文件，确保软件质量
└── .gitignore
└── .markdownlintrc 
└── .npmignore 
└── .travis.yml  
├── CHANGELOG.md   
├── CONTRIBUTING.md  
├── LICENSE.md      
├── README.md       
├── .codecov.yml    
├── package.json    
└── yarn.lock     

简要说明

• .gitignore, .npmignore, .travis.yml: 这些是构建和持续集成(CI)过程的重要组成部分。
• CHANGELOG.md: 存储了项目的变更记录，通常由 auto-changelog 自动更新。
• CONTRIBUTING.md: 描述了贡献者如何向项目做出贡献的指导方针。
• LICENSE.md: 提供项目的许可详情，通常是 MIT 许可证。
• README.md: 介绍了项目的主要特性以及基本的使用方法。

启动文件介绍

auto-changelog 的主要入口点可以通过在终端运行命令来触发。虽然没有单独指定的“启动”文件，但可以在项目的根目录中通过以下方式调用它:

$ npx auto-changelog [options]

或者在全局安装之后，可以简单地运行：

$ auto-changelog [options]

其中 [options] 可以是 -h 或 --help 来显示帮助信息，或者使用其他选项来自定义输出，例如指定输出文件名、版本号等。

配置文件介绍

auto-changelog 支持两种类型的配置文件，以定制其行为：

1. 在 package.json 中设置配置

{
  "auto-changelog": {
    "output": "HISTORY.md", 
    "template": "keepachangelog",
    "unreleased": true,
    "commitLimit": false
  }
}

这些字段表示：

• output: 输出文件名，默认为 CHANGELOG.md。
• template: 使用的模板类型，默认为 'compact'，也可以指向自定义模板路径。
• unreleased: 是否包括未发布的更改部分。
• commitLimit: 是否限制包含的提交数量，这里设为 false 表示不限制。

2. 自定义配置文件

可以创建名为 auto-changelog 的 JSON 文件在项目根目录下：

{
  "output": "HISTORY.md",
  "template": "keepachangelog",
  "unreleased": true,
  "commitLimit": false
}

请注意，在 package.json 中的任何配置都将覆盖相同键上的自定义文件中的值。这意味着在多个地方设置相同的参数时，package.json 中的值将优先考虑。

以上就是关于 auto-changelog 项目基本目录结构、启动文件以及配置方式的详细介绍。希望这可以帮助您更好地理解和利用此项目进行变更日志管理。

auto-changelogCommand line tool for generating a changelog from git tags and commit history项目地址:https://gitcode.com/gh_mirrors/au/auto-changelog