github

Documentation

Index

• func FetchOrgRepos(org OrgConfig) ([]repos.RepoDetails, error)
• type OrgConfig
  • func (oc *OrgConfig) GithubClient() *gh.Client
  • func (oc *OrgConfig) SetGithubToken(token string)
• type Repository
  • func (r *Repository) IsArchived(ctx context.Context) bool
  • func (r *Repository) Process(ctx context.Context) error

Functions

func FetchOrgRepos

func FetchOrgRepos(org OrgConfig) ([]repos.RepoDetails, error)

FetchOrgRepos creates a slice of RepoDetails types representing the repos owned by the specified teams in the Github org.

Types

type OrgConfig

type OrgConfig struct {
	Org          string   `mapstructure:"org"`
	Teams        []string `mapstructure:"teams"`
	IgnoredRepos []string `mapstructure:"ignores"`
	// contains filtered or unexported fields
}

OrgConfig contains fields used in releasegen's config.yaml file to configure its behaviour when generating reports about Github repositories.

func (*OrgConfig) GithubClient

func (oc *OrgConfig) GithubClient() *gh.Client

GithubClient returns either a new instance of the Github client, or a previously initialised client.

func (*OrgConfig) SetGithubToken

func (oc *OrgConfig) SetGithubToken(token string)

SetGithubToken enables the setting of the Github token for the Github org.

type Repository

type Repository struct {
	Details repos.RepoDetails
	// contains filtered or unexported fields
}

Repository represents a single Github Repository.

func (*Repository) IsArchived

func (r *Repository) IsArchived(ctx context.Context) bool

IsArchived indicates whether or not the repository is marked as archived on Github.

func (*Repository) Process

func (r *Repository) Process(ctx context.Context) error

Process populates the Repository with details of its releases, and commits.