gitinfo

package module

v0.0.0-...-1c25fbd Latest Latest Go to latest Published: Dec 22, 2019 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/LeKovr/gitinfo

README ¶

gitinfo

Get git repo metagata (lib) and generate gitinfo.json via go generate (cmd)

Requirements

git binary have to be in $PATH

Install

go get github.com/LeKovr/gitinfo/...

Usage

import "github.com/LeKovr/gitinfo"

func main() {
    data, err := gitinfo.New("sql/")
    if err != nil {
	return err
    }
    log.Printf("%#v\n",data)
}

Generate

//go:generate gitinfo sql/

Documentation ¶

Index ¶

func MkTime(in []byte, rv *time.Time) error
func Modified(path string, rv *time.Time) error
func Repository(path string, rv *string) error
func Version(path string, rv *string) error
type Config
type GitInfo
type Service
- func New(cfg Config) *Service

Examples ¶

New

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MkTime ¶

func MkTime(in []byte, rv *time.Time) error

MkTime converts []byte to time.Time

func Modified ¶

func Modified(path string, rv *time.Time) error

Modified fills rv with package last commit timestamp

func Repository ¶

func Repository(path string, rv *string) error

Repository fills rv with package repo from git

func Version ¶

func Version(path string, rv *string) error

Version fills rv with package version from git

Types ¶

type Config ¶

type Config struct {
	Debug bool   `long:"debug" description:"Show debug data"`
	File  string `long:"file" default:"gitinfo.json" description:"GitInfo json filename"`
}

Config holds all config vars

type GitInfo ¶

type GitInfo struct {
	Version    string    `json:"version"`
	Repository string    `json:"repository"`
	Modified   time.Time `json:"modified"`
}

type Service ¶

type Service struct {
	Config
	GI *GitInfo
}

GitInfo holds git repository metadata

func New ¶

func New(cfg Config) *Service

New returns service object with config

Example ¶

cfg := Config{}
// Fill config with default values
p := flags.NewParser(&cfg, flags.Default|flags.IgnoreUnknown)
_, err := p.Parse()
//        require.NoError(ss.T(), err)

var gi GitInfo
err = New(cfg).Make("cmd/", &gi)
if err != nil {
	fmt.Printf("%#v\n", err)
}
fmt.Printf("%v\n%v\n%v\n",
	gi.Modified != time.Time{},
	gi.Version != "",
	strings.HasSuffix(gi.Repository, "LeKovr/gitinfo.git"),
)

Output:

true
true
true

func (Service) Make ¶

func (srv Service) Make(path string, gi *GitInfo) error

Make prepares GitInfo data

func (Service) Read ¶

func (srv Service) Read(fs http.FileSystem, path string) (*GitInfo, error)

Red reads GitInfo data from file

func (Service) Write ¶

func (srv Service) Write(path string, gi *GitInfo) error

Write saves GitInfo data to file, prepare it if none given

Source Files ¶

View all Source files

gitinfo.go

Directories ¶

Path	Synopsis
cmd
gitinfo

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL