一款根据 git 提交记录生成 changelog 的实用工具


安装

  • 安装 Ruby
  • 安装工具 命令行执行 gem install github_changelog_generator
  • 生成 GitHub token, 否则请求 api 过多会被限制,报错:GitHub API rate limit exceeded
  • 新建换进变量 CHANGELOG_GITHUB_TOKEN 填写上一步生成的 token

使用

  • 打开对应代码目录执行 github_changelog_generator -u github_project_namespace -p github_project 该目录下就会生成 CHANGELOG.md

  • 例如:

    1
    2
    
    github_changelog_generator -u giant-app -p livewallpaper
    github_changelog_generator -u giant-app -p livewallpaperengine
    

官方文档