github

Documentation

Index

• func Visit(visitor *vc.Visitor) error
• type Iterator
  • func (i *Iterator) Error() error
  • func (i *Iterator) Next() bool
  • func (i *Iterator) Page() []vc.Target
• type Release

Functions

func Visit

func Visit(visitor *vc.Visitor) error

Visit uses the supplied visitor to aggregate release info from the github releases api.

Types

type Iterator

type Iterator struct {
	// contains filtered or unexported fields
}

Iterator allows lazy consumption of github release pages. Not safe for concurrent use. Always check for err after iteration, even if one or more pages were loaded successfully. If a release being added concurrently with iteration may cause duplicate releases to be observed.

func (*Iterator) Error

func (i *Iterator) Error() error

Error checks if an error occurred during iteration.

func (*Iterator) Next

func (i *Iterator) Next() bool

Next attempts to load the next page.

func (*Iterator) Page

func (i *Iterator) Page() []vc.Target

Page loads the current page. Must not be called until after Next() has been called. Subsequent calls between calls to Next() return the same value.

type Release

type Release struct {
	// Version is the semver version from the git tag of the release.
	Version string

	// OtherLabels are the labels extracted from the release notes.
	OtherLabels map[string]string
}

Release represents a github release.