github

Documentation

Index

• Constants
• func NewGithubCollector(opts ...Opt) (*githubCollector, error)
• type Config
• type Opt
  • func WithAssetSuffixes(assetSuffixes []string) Opt
  • func WithClient(client githubclient.GithubClient) Opt
  • func WithCollectDataSource(collectDataSource datasource.CollectSource) Opt
  • func WithMode(githubMode string) Opt
  • func WithOwner(owner string) Opt
  • func WithPolling(interval time.Duration) Opt
  • func WithRelease(isRelease bool) Opt
  • func WithRepo(repo string) Opt
  • func WithRepoToReleaseTags(repoToReleaseTags map[client.Repo][]TagOrLatest) Opt
  • func WithSbomName(sbomName string) Opt
  • func WithWorkflowName(workflowName string) Opt
• type TagOrLatest
  • func ParseGitDataSource(source datasource.Source) (*client.Repo, TagOrLatest, error)
  • func ParseGithubReleaseDataSource(source datasource.Source) (*client.Repo, TagOrLatest, error)

Constants

const (
	GithubCollector = "GithubCollector"
	Latest          = ""
)

Functions

func NewGithubCollector

func NewGithubCollector(opts ...Opt) (*githubCollector, error)

Types

type Config

type Config struct {
	Poll              bool
	Interval          time.Duration
	Client            githubclient.GithubClient
	RepoToReleaseTags map[client.Repo][]TagOrLatest
	AssetSuffixes     []string
	CollectDataSource datasource.CollectSource
}

type Opt

type Opt func(*githubCollector)

func WithAssetSuffixes

func WithAssetSuffixes(assetSuffixes []string) Opt

func WithClient

func WithClient(client githubclient.GithubClient) Opt

func WithCollectDataSource

func WithCollectDataSource(collectDataSource datasource.CollectSource) Opt

func WithMode

func WithMode(githubMode string) Opt

func WithOwner

func WithOwner(owner string) Opt

func WithPolling

func WithPolling(interval time.Duration) Opt

func WithRelease

func WithRelease(isRelease bool) Opt

func WithRepo

func WithRepo(repo string) Opt

func WithRepoToReleaseTags

func WithRepoToReleaseTags(repoToReleaseTags map[client.Repo][]TagOrLatest) Opt

func WithSbomName

func WithSbomName(sbomName string) Opt

func WithWorkflowName

func WithWorkflowName(workflowName string) Opt

type TagOrLatest

type TagOrLatest = string

TagOrLatest is either a tag or if it's the empty string "" then it should be considered latest

func ParseGitDataSource

func ParseGitDataSource(source datasource.Source) (*client.Repo, TagOrLatest, error)

ParseGitDataSource takes in a data URL should be in the form: <vcs_tool>+<transport>://<host_name>[/<path_to_repository>][@<revision_tag_or_branch>][#<sub_path>]

func ParseGithubReleaseDataSource

func ParseGithubReleaseDataSource(source datasource.Source) (*client.Repo, TagOrLatest, error)

ParseGithubReleaseDataSource takes in a data source and parses it assuming it's a Github URL