gitlog

Documentation

Overview

Package gitlog reads commit history with go-git (no git binary).

Index

• Variables
• func Bind(c *CLI) *flaggy.Parser
• func ParseSince(s string) (time.Time, error)
• func Parser() *flaggy.Parser
• func RepoName(repo string) (string, error)
• type CLI
  • func ParseArgs(args []string) (CLI, error)
• type Commit
  • func Log(repo string, opt Options) ([]Commit, error)
• type Leaf
  • func ToLeaf(c Commit, repo string) Leaf
• type Options

Variables

var Stop = fmt.Errorf("gitlog: stop")

Stop ends a log walk early (limit reached).

Functions

func Bind

func Bind(c *CLI) *flaggy.Parser

func ParseSince

func ParseSince(s string) (time.Time, error)

func Parser

func Parser() *flaggy.Parser

func RepoName

func RepoName(repo string) (string, error)

Types

type CLI

type CLI struct {
	Repo, Root, Since string
	Limit             int
	JSONOut           bool
}

func ParseArgs

func ParseArgs(args []string) (CLI, error)

type Commit

type Commit struct {
	SHA     string   `json:"sha"`
	Author  string   `json:"author"`
	Email   string   `json:"email"`
	Date    string   `json:"date"`
	Subject string   `json:"subject"`
	Files   []string `json:"files"`
}

func Log

func Log(repo string, opt Options) ([]Commit, error)

Log walks commits from HEAD, newest first, skipping merges.

type Leaf

type Leaf struct {
	Source  string `json:"source"`
	Repo    string `json:"repo"`
	Heading string `json:"heading"`
	Text    string `json:"text"`
	Type    string `json:"type"`
	Status  string `json:"status"`
	Related string `json:"related"`
}

func ToLeaf

func ToLeaf(c Commit, repo string) Leaf

type Options

type Options struct {
	Limit int
	Since time.Time
}