English | 中文简体

whatchanged

An elegant changelog generator. follow the Conventional Commits Specification to generate a beautiful and neat change log.

Focus on Elegant/Simple/Efficient/Scalable

Feel the magic online

Feature:

• Cross-platform support
• Generation for local/Remote git repositories
• Preset template for generation
• Custom template file
• Conventional Commits Specification Parser
• Generate multiple versions of change logs
• Github Action
• Visual Studio Code extension

Usage

$ whatchanged --help

Install

1. Shell (Mac/Linux)

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

2. PowerShell (Windows):

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

3. Github release page (All platforms)

   download the executable file and put the executable file to $PATH

4. Build and install from source using Golang (All platforms)

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

Use as library

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

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)
}

FAQ

1. How it works?
2. How to custom generation template?

License

The Anti-996 License