github

Documentation

Index

• Constants
• Variables
• type Provider
  • func (c Provider) GetReleases(name string, max int) (rs *results.ResultSet, s results.Status)
  • func (c Provider) Latest(name string) (r *results.Result, s results.Status)
  • func (c Provider) Match(query string) string
  • func (c Provider) Name() string
  • func (c Provider) Releases(name string) (rs *results.ResultSet, s results.Status)
• type RepoQuery
• type RepoQueryResult
  • func (rqr RepoQueryResult) Convert(name string) (rs *results.ResultSet)

Constants

const GraphQLAPI = "https://api.github.com/graphql"

GraphQLAPI is the location of the GraphQL Endpoint

const RepoQueryFormat = `` /* 391-byte string literal not displayed */

RepoQueryFormat is the text format for the necessary GraphQL query

const (
	// SourceFormat is the format string for Github release tarballs
	SourceFormat = "https://github.com/%s/archive/%s.tar.gz"
)

Variables

var SourceRegex = regexp.MustCompile("github.com/([^/]+/[^/.]+)")

SourceRegex is the regex for Github sources

var VersionRegex = regexp.MustCompile("(?:\\d+\\.)*\\d+\\w*")

VersionRegex is used to parse Github version numbers

Types

type Provider

type Provider struct{}

Provider is the upstream provider interface for github

func (Provider) GetReleases

func (c Provider) GetReleases(name string, max int) (rs *results.ResultSet, s results.Status)

GetReleases gets a number of releases for a given repo

func (Provider) Latest

func (c Provider) Latest(name string) (r *results.Result, s results.Status)

Latest finds the newest release for a github package

func (Provider) Match

func (c Provider) Match(query string) string

Match checks to see if this provider can handle this kind of query

func (Provider) Name

func (c Provider) Name() string

Name gives the name of this provider

func (Provider) Releases

func (c Provider) Releases(name string) (rs *results.ResultSet, s results.Status)

Releases finds all matching releases for a github package

type RepoQuery

type RepoQuery struct {
	Query string `json:"query"`
}

RepoQuery is the JSON payload for this request

type RepoQueryResult

type RepoQueryResult struct {
	Data struct {
		Repository struct {
			Releases struct {
				Nodes []struct {
					Name         string `json:"name"`
					PublishedAt  string `json:"publishedAt"`
					IsPrerelease bool   `json:"isPrerelease"`
					Tag          struct {
						Name string `json:"name"`
					} `json:"tag"`
				} `json:"nodes"`
			} `json:"releases"`
			Refs struct {
				Nodes []struct {
					Name string `json:"name"`
				} `json:"nodes"`
			} `json:"refs"`
		} `json:"repository"`
	} `json:"data"`
}

RepoQueryResult is the JSON payload of the response

func (RepoQueryResult) Convert

func (rqr RepoQueryResult) Convert(name string) (rs *results.ResultSet)

Convert turns a RepoQueryResult into a Cuppa ResultSet