GitHub Changelog Generator 使用教程

GitHub Changelog Generator 使用教程

github-changelog-generatorGenerates release notes that can be published to GitHub项目地址:https://gitcode.com/gh_mirrors/git/github-changelog-generator

1. 项目的目录结构及介绍

GitHub Changelog Generator 项目的目录结构如下：

github-changelog-generator/
├── bin/
│   └── github_changelog_generator
├── lib/
│   ├── github_changelog_generator/
│   │   ├── generator.rb
│   │   ├── helper.rb
│   │   └── version.rb
│   └── github_changelog_generator.rb
├── spec/
│   ├── github_changelog_generator_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── CHANGELOG.md
├── Gemfile
├── LICENSE.txt
├── README.md
└── github-changelog-generator.gemspec

目录结构介绍

• bin/: 包含可执行文件 github_changelog_generator。
• lib/: 包含项目的核心代码，其中 github_changelog_generator.rb 是主文件。
• spec/: 包含测试文件。
• .gitignore: Git 忽略文件配置。
• .rspec: RSpec 配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目变更日志。
• Gemfile: 依赖管理文件。
• LICENSE.txt: 项目许可证。
• README.md: 项目说明文档。
• github-changelog-generator.gemspec: 项目 gem 规范文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 github_changelog_generator。这个文件是项目的入口点，负责启动和运行 GitHub Changelog Generator。

3. 项目的配置文件介绍

GitHub Changelog Generator 的配置主要通过命令行参数进行。以下是一些常用的配置参数：

• --user: GitHub 用户名。
• --project: GitHub 项目名。
• --token: GitHub API 令牌，用于访问私有仓库。
• --since-tag: 从指定标签开始生成变更日志。
• --future-release: 指定未来的发布版本。

例如，运行以下命令生成变更日志：

github_changelog_generator --user spring-io --project github-changelog-generator --token YOUR_GITHUB_TOKEN

通过这些参数，可以灵活配置生成变更日志的范围和细节。

github-changelog-generatorGenerates release notes that can be published to GitHub项目地址:https://gitcode.com/gh_mirrors/git/github-changelog-generator