github

Documentation

Index

• type GitHub
  • func NewGitHubClient() GitHub
  • func (g *GitHub) Download(projectName string) ([]types.ReleaseNote, error)
  • func (g *GitHub) HasRequestSlot() bool
  • func (g *GitHub) SetPersonalToken(token string)
  • func (g *GitHub) SyncStats(resp *http.Response)
• type GitHubStats

Types

type GitHub

type GitHub struct {
	Initialized   bool // first call to github will get all stats by quotes and rate limits
	Client        http.Client
	GitHubStats   GitHubStats
	PersonalToken string
}

func NewGitHubClient

func NewGitHubClient() GitHub

func (*GitHub) Download

func (g *GitHub) Download(projectName string) ([]types.ReleaseNote, error)

func (*GitHub) HasRequestSlot

func (g *GitHub) HasRequestSlot() bool

func (*GitHub) SetPersonalToken

func (g *GitHub) SetPersonalToken(token string)

func (*GitHub) SyncStats

func (g *GitHub) SyncStats(resp *http.Response)

rate limit reset updated every ~hour

type GitHubStats

type GitHubStats struct {
	RateLimit         int   // X-RateLimit-Limit 		| 60 			| In units
	RateLimitRemaning int   // X-RateLimit-Remaining 	| 0 			| In units
	RateLimitReset    int64 // X-RateLimit-Reset 		| 1679179139 	| In seconds updated every ~hour
	RateLimitUsed     int   // X-RateLimit-Used 		| 60			| In units

	WaitSlotSeconds int // Seconds to reset RateLimit slots, if negative free to go
}