Skip to content

Latest commit

 

History

History
106 lines (72 loc) · 2.89 KB

README.md

File metadata and controls

106 lines (72 loc) · 2.89 KB

English | 中文简体

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

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:

Usage

$ whatchanged --help

Install

  1. Cask

    cask install github.com/release-lab/whatchanged
  2. Shell (Mac/Linux)

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

    $r="release-lab/whatchanged";iwr https://github.com/release-lab/install/raw/v1/install.ps1 -useb | iex
  4. Github release page (All platforms)

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

  5. 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