Skip to content

Latest commit

 

History

History
176 lines (131 loc) · 5.6 KB

README_zh-CN.md

File metadata and controls

176 lines (131 loc) · 5.6 KB

English | 中文简体

Build Status Build Status Go Report Card Latest Version 996.icu Repo Size

whatchanged

一个优雅的变更日志生成器

致力于优雅/简单/高效/可扩展

在线感受魔法

特性:

  • 跨平台支持
  • 生成 本地/远程 的git仓库
  • 内置预设的生成模板
  • 自定义模版文件
  • 常规的 commit 解析器
  • 支持多个版本的变更日志生成
  • Github Action

使用

$ whatchanged --help
whatchanged - a cli to generate changelog from git project

USAGE:
  whatchanged [OPTIONS] [version...]

ARGUMENTS:
  [version...]  Optional version or version range.
                1.null.
                  If you do not specify the version, then it will automatically
                  generate a change log from "HEAD~<latest version>" or
                  "HEAD~<earliest commit>" or "<latest version>-<last version>"
                2.single version. eg. "v1.2.0"
                  Generate a specific version of the changelog.
                3.multiple versions. eg. "v2.0.0 v1.0.0"
                4.version range. eg v1.3.0~v1.2.0
                  Generate changelog within the specified range.
                  For more details, please check the following examples.

OPTIONS:
  --help        Print help information.
  --version     Print version information.

  --project     Specify the project to be generated. It can be a relative path.
                or an absolute path or even a remote Git URL. eg.
                --project=/path/to/project/which/contains/.git/folder
                --project=https://github.com/axetroy/whatchanged.git
                Defaults to "--project=$PWD".
  --output      Write output to file. default write to stdout.

  --fmt         Specify the changelog format. Available options:
                --fmt=md
                --fmt=json
                Defaults to "--fmt=md".
  --preset      Cli built-in markdown template. Available options:
                --preset=default
                --preset=full
                --preset=simple
                Only available when --fmt=md and --tpl is nil.
                Defaults to "--preset=default".
  --tpl         Specify the template file for generating. Only available when
                --fmt=md.
  --skip-format Skip the formatting process, which is very useful for keeping the
                original format.

EXAMPLES:
  # generate changelog from HEAD to <latest version>.
  # if HEAD is not the latest tag. then this should be a unreleased version
  # otherwise it should be the latest version
  $ whatchanged

  # generate changelog of the specified version
  $ whatchanged v1.2.0

  # Generate the specified two versions
  # Separate by a comma, and only generate these two versions
  # the middle version will not be generated
  $ whatchanged v2.0.0 v1.0.0

  # generate HEAD to latest tag and <Nth tag>
  $ whatchanged HEAD~@0 @1 @2

  # generate changelog within the specified range
  $ whatchanged v1.3.0~v1.2.0

  # generate changelog from HEAD to <Nth tag>
  $ whatchanged ~@0

  # generate changelog from <0th tag> to <2th tag>
  $ whatchanged @0~@2

  # generate changelog from HEAD to specified version
  $ whatchanged HEAD~v1.3.0

  # generate all changelog
  $ whatchanged HEAD~

  # generate changelog from two commit hashes
  $ whatchanged 770ed02~585445d

  # Generate changelog for the specified project
  $ whatchanged --project=/path/to/project v1.0.0

  # Generate changelog for the remote project
  $ whatchanged --project=https://github.com/axetroy/whatchanged.git v0.1.0

SOURCE CODE:
  https://github.com/axetroy/whatchanged

安装

通过 npm 安装

# install in global
npm install -g @axetroy/whatchanged
# run the command once
npx @axetroy/whatchanged

通过 shell 安装

如果你使用的是 Linux/macOS，你可以通过以下命令进行安装

# 安装最新版本
curl -fsSL https://raw.githubusercontent.com/axetroy/whatchanged/master/install.sh | bash
# 或者安装指定版本
curl -fsSL https://raw.githubusercontent.com/axetroy/whatchanged/master/install.sh | bash -s v0.3.6
# 或者通过 gobinaries.com 安装
curl -sf https://gobinaries.com/axetroy/whatchanged@v0.3.6 | sh

通过 Github release 页面下载安装

从release page页面下载对应平台的可执行文件，并且把它加入到 $PATH 环境变量中，并尝试以下命令

$ whatchanged --help

从源码中构建

确保你已安装 Golang@v1.16.x 和 goreleaser

$ git clone https://github.com/axetroy/whatchanged.git $GOPATH/src/github.com/axetroy/whatchanged
$ cd $GOPATH/src/github.com/axetroy/whatchanged
$ make build

测试

$ make test

常见问题

  1. 它是如何工作的?
  2. 如何自定义生成的模版?

开源许可

The Anti-996 License