gigi

README

gigi

Background

Description

Features

Synopsis

$ gigi

Options

Limitation

Installation

$ go install github.com/budougumi0617/gigi/cmd/gigi

Built binaries are available on gihub releases. https://github.com/budougumi0617/gigi/releases

MacOS

If you want to install on MacOS, you can use Homebrew.

brew install budougumi0617/tap/gigi

Contribution

1. Fork (https://github.com/budougumi0617/gigi/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

License

MIT

Author

budougumi0617

Documentation

Index

• Variables
• func Report(ctx context.Context, cfg Config, result *Result) error
• type Config
  • func Load() (Config, error)
• type EventType
• type File
• type Result
  • func GetDiffs(ctx context.Context, cfg Config) (*Result, error)

Variables

var ErrNoEventTypePullRequest = fmt.Errorf("not pull_request event")

Functions

func Report

func Report(ctx context.Context, cfg Config, result *Result) error

Types

type Config

type Config struct {
	Owner, Repository string
	PullRequestNumber int
	GitHubToken       string
	MaxAddedCount     int
	Filter            *regexp.Regexp
	Version           string
	Revision          string
}

func Load

func Load() (Config, error)

type EventType

type EventType string

const EventTypePullRequest EventType = "pull_request"

type File

type File struct {
	Name       string
	AddedCount int
}

type Result

type Result struct {
	TotalAddedCount int
	Files           []File
	Filtered        []File
}

func GetDiffs

func GetDiffs(ctx context.Context, cfg Config) (*Result, error)