https://github.com/release-lab/whatchanged

Elegant changelog generator. 优雅的变更日志生成器
https://github.com/release-lab/whatchanged

build-tool changelog changelog-generator cli go golang

Last synced: 4 months ago
JSON representation

Elegant changelog generator. 优雅的变更日志生成器

• Host: GitHub
• URL: https://github.com/release-lab/whatchanged
• Owner: release-lab
• License: other
• Created: 2020-11-19T07:15:55.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T02:42:50.000Z (4 months ago)
• Last Synced: 2024-07-23T05:25:02.806Z (4 months ago)
• Topics: build-tool, changelog, changelog-generator, cli, go, golang
• Language: Go
• Homepage: https://release-lab.github.io
• Size: 10.6 MB
• Stars: 55
• Watchers: 1
• Forks: 9
• Open Issues: 17
• Metadata Files:
  • Readme: README-zh-CN.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
中文简体 | [English](README.md)

[![Build Status](https://github.com/release-lab/whatchanged/workflows/ci/badge.svg)](https://github.com/release-lab/whatchanged/actions)

[![Build Status](https://github.com/release-lab/whatchanged/workflows/playground/badge.svg)](https://github.com/release-lab/whatchanged/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/release-lab/whatchanged)](https://goreportcard.com/report/github.com/release-lab/whatchanged)

![Latest Version](https://img.shields.io/github/v/release/release-lab/whatchanged.svg)

[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)

![Repo Size](https://img.shields.io/github/repo-size/release-lab/whatchanged.svg)

## whatchanged

一个优雅的变更日志生成器，只需遵循 [Conventional Commits 规范](https://www.conventionalcommits.org/en/v1.0.0/)，即可生成一个漂亮的，工整的变更日志。

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

[在线感受魔法](https://release-lab.github.io)

特性:

- [x] 跨平台支持

- [x] 生成 本地/远程 的 git 仓库

- [x] 内置预设的生成模板

- [x] 自定义模版文件

- [x] [Conventional Commits 规范解析器](https://github.com/release-lab/conventional-commit-parser)

- [x] 支持多个版本的变更日志生成

- [x] [Github Action](https://github.com/release-lab/setup-whatchanged)

- [x] [Visual Studio Code extension](https://github.com/release-lab/vscode-whatchanged)

### 使用

```bash

$ whatchanged --help

```

### 安装

1. [Cask](https://github.com/axetroy/cask.rs)

   ```bash

   cask install github.com/release-lab/whatchanged

   ```

2. Shell (Mac/Linux)

   ```bash

   curl -fsSL https://github.com/release-lab/install/raw/v1/install.sh | bash -s -- -r=release-lab/whatchanged

   ```

3. PowerShell (Windows):

   ```powershell

   $r="release-lab/whatchanged";iwr https://github.com/release-lab/install/raw/v1/install.ps1 -useb | iex

   ```

4. 从 [Github Release Page](https://github.com/release-lab/whatchanged/releases) 下载 (全平台支持)

   下载可执行文件，并且把它加入到`$PATH` 环境变量中

5. 使用 [Golang](https://golang.org) 从源码中构建并安装 (全平台支持)

   ```bash

   go install github.com/release-lab/whatchanged/cmd/whatchanged

   ```

### 作为库使用

```bash

# 安装包

go get -v -u github.com/release-lab/whatchanged

```

```go

package main

import (

   "context"

   "bytes"

   "github.com/release-lab/whatchanged"

)

func main() {

   output := bytes.NewBuffer([]byte{})

   option := whatchanged.Options{

      Version: []string{"HEAD~"}

   }

   err := whatchanged.Generate(context.Background(), "/path/to/git/project", output, &option)

   if err!=nil{

      panic(err)

   }

   println(output)

}

```

### 常见问题

1. [它是如何工作的?](HOW_IT_WORKS.md)

2. [如何自定义生成的模版?](CUSTOM_TEMPLATE.md)

### 开源许可

The [Anti-996 License](LICENSE_zh-CN)