releasenotes

Documentation

Index

• func Format(commits []GitCommit, maxChars int) string
• type GitCommit
  • func GitLog(ctx context.Context, sinceRef, untilRef string) ([]GitCommit, error)

Functions

func Format

func Format(commits []GitCommit, maxChars int) string

Format converts commits into a bullet-point release notes string. Truncates to maxChars (Google Play limit is 500 chars). Truncation removes whole lines to avoid cutting mid-sentence, and appends "..." if any lines were dropped.

Types

type GitCommit

type GitCommit struct {
	Hash    string `json:"hash"`
	Subject string `json:"subject"`
}

GitCommit represents a single git commit.

func GitLog

func GitLog(ctx context.Context, sinceRef, untilRef string) ([]GitCommit, error)

GitLog runs `git log --no-merges --format="%h%x00%s"` between refs and returns commits. sinceRef is the starting ref (exclusive), untilRef is the ending ref (inclusive).