github

Documentation

Overview

Package github is used to access GitHub to find latest version in repositories

Index

• type Credentials
• type Repo
• type RepoVersionGetter
  • func NewRepoVersionGetter(ctx context.Context, credentials Credentials) RepoVersionGetter
• type Repos

Types

type Credentials

type Credentials struct {
	Username string `koanf:"username"`
	Password string `koanf:"password"`
	Token    string `koanf:"token"`
}

Credentials contains access details for GitHub

type Repo

type Repo struct {
	Repo    string `koanf:"repo"`
	Version string `koanf:"version"`
	UseTag  bool   `koanf:"useTag"`
}

Repo contains repositories that need to be checked for a new version

type RepoVersionGetter

type RepoVersionGetter interface {
	GetLatestVersion(ctx context.Context, gitRepo Repo) (string, error)
	GetLatestVersionFromRelease(ctx context.Context, owner string, repo string) (string, error)
	GetLatestVersionFromTag(ctx context.Context, owner string, repo string) (string, error)
}

RepoVersionGetter is an interface that wraps calls to GitHub

func NewRepoVersionGetter

func NewRepoVersionGetter(ctx context.Context, credentials Credentials) RepoVersionGetter

NewRepoVersionGetter is used to construct authenticated or unauthenticated access to GitHub It returns an implementation of the GitHub client represented as the RepoVersionGetter interface

type Repos

type Repos struct {
	Credentials Credentials `koanf:"credentials"`
	Repos       []Repo      `koanf:"repos"`
}

Repos contains all the GitHub repositories and security information to watch for new versions on GitHub