Categorygithub.com/release-lab/whatchanged
modulepackage
0.5.7
Repository: https://github.com/release-lab/whatchanged.git
Documentation: pkg.go.dev

# README

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

# Packages

No description provided by the author

# Functions

No description provided by the author
No description provided by the author
generate changelog project: it could be a file path or a git URL.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
format.
preset.
No description provided by the author

# Variables

go:embed template/*.tpl.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-header.

# Type aliases

No description provided by the author
No description provided by the author