github

package

v0.0.16 Latest Latest Go to latest Published: May 21, 2022 License: MIT Imports: 8 Imported by: 1

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

This section is empty.

This section is empty.

func PrepareForGetJCLIAsset(ver string) (client *github.Client, teardown func())

PrepareForGetJCLIAsset only for test

func PrepareForGetLatestJCLIAsset() (client *github.Client, teardown func())

PrepareForGetLatestJCLIAsset only for test

func PrepareForGetLatestReleaseAsset() (client *github.Client, teardown func())

PrepareForGetLatestReleaseAsset only for test

func PrepareForGetReleaseAssetByTagName() (client *github.Client, teardown func())

PrepareForGetReleaseAssetByTagName only for test

type Release struct {
	TagName string
	ID      int64
}

Release represents a GitHub release

type ReleaseAsset struct {
	TagName string
	Body    string
}

ReleaseAsset is the asset from GitHub release

type ReleaseClient struct {
	Client *github.Client
	Org    string
	Repo   string
}

ReleaseClient is the client of GitHub

func (g *ReleaseClient) GetJCLIAsset(tagName string) (*ReleaseAsset, error)

GetJCLIAsset returns the asset from a tag name

func (g *ReleaseClient) GetLatestReleaseAsset(owner, repo string) (ra *ReleaseAsset, err error)

GetLatestReleaseAsset returns the latest release asset

func (g *ReleaseClient) GetReleaseAssetByTagName(owner, repo, tagName string) (ra *ReleaseAsset, err error)

GetReleaseAssetByTagName returns the release asset by tag name

func (g *ReleaseClient) GetReleaseList(owner, repo string, count int) (list []Release, err error)

GetReleaseList returns a list of release

func (g *ReleaseClient) GetTagList(owner, repo string, count int) (list []Tag, err error)

GetTagList returns a list of tag

func (g *ReleaseClient) Init()

Init inits the GitHub client

type Tag struct {
	Name string
}

Tag represents a tag of a git repository