github

package

Go to main page

Versions in this module

v0

v0.0.8

Jul 4, 2025

v0.0.7

Jun 27, 2025

v0.0.6

Jun 6, 2025

Changes in this version

+ const CACHE_PATH

+ func CachePath(outputAdapter, method string) string

+ func GetAllOrgRepositories(ctx tcontext.TransferMetadata, client *githublib.Client, org string) ([]string, error)

+ type AdapterCache map[string]GitHubDaemonCache

+ type Cache struct

+ Data map[string]AdapterCache

+ func NewCache() *Cache

+ func (c *Cache) EnsureCachePath(ctx tcontext.TransferMetadata, outputAdapter, inputAdapter string)

+ func (c *Cache) InitCache(ctx tcontext.TransferMetadata, outputAdapter, method string) error

+ func (c *Cache) IsSBOMProcessed(ctx tcontext.TransferMetadata, ...) bool

+ func (c *Cache) LoadCache(ctx tcontext.TransferMetadata, adapter, method string) error

+ func (c *Cache) MarkSBOMProcessed(ctx tcontext.TransferMetadata, ...) error

+ func (c *Cache) PruneSBOMs(ctx tcontext.TransferMetadata, ...) error

+ func (c *Cache) SaveCache(ctx tcontext.TransferMetadata, adapter, method string) error

type GitHubAdapter

+ Config *GithubConfig

+ Fetcher SBOMFetcher

+ type GitHubDaemonCache map[string]MethodCache

+ type GithubConfig struct

+ AssetWaitDelay int64

+ BinaryPath string

+ Branch string

+ Daemon bool

+ ExcludeRepos []string

+ IncludeRepos []string

+ Method string

+ Owner string

+ Poll int64

+ ProcessingMode types.ProcessingMode

+ Repo string

+ Token string

+ URL string

+ Version string

+ func NewGithubConfig() *GithubConfig

+ func (c *GithubConfig) GetGitHubClient(ctx tcontext.TransferMetadata) (*githublib.Client, error)

+ func (c *GithubConfig) GetRepo() string

+ func (c *GithubConfig) SetBranch(branch string)

+ func (c *GithubConfig) SetExcludeRepos(repos []string)

+ func (c *GithubConfig) SetIncludeRepos(repos []string)

+ func (c *GithubConfig) SetMethod(method string)

+ func (c *GithubConfig) SetOwner(org string)

+ func (c *GithubConfig) SetPollInterval(interval int64)

+ func (c *GithubConfig) SetProcessingMode(mode types.ProcessingMode)

+ func (c *GithubConfig) SetRepo(repo string)

+ func (c *GithubConfig) SetToken(token string)

+ func (c *GithubConfig) SetVersion(version string)

+ type GithubReporter struct

+ func NewGithubReporter(verbose bool, inputDir string) *GithubReporter

+ func (r *GithubReporter) DryRun(ctx tcontext.TransferMetadata, iter iterator.SBOMIterator) error

+ type GithubWatcherFetcher struct

+ func NewWatcherFetcher() *GithubWatcherFetcher

+ func (f *GithubWatcherFetcher) Fetch(ctx tcontext.TransferMetadata, config *GithubConfig) (iterator.SBOMIterator, error)

+ type GithubWatcherIterator struct

+ func (it *GithubWatcherIterator) Next(ctx tcontext.TransferMetadata) (*iterator.SBOM, error)

+ type MethodCache struct

+ Repos map[string]RepoState

+ SBOMs map[string]bool

+ type ParallelFetcher struct

+ func (f *ParallelFetcher) Fetch(ctx tcontext.TransferMetadata, config *GithubConfig) (iterator.SBOMIterator, error)

+ type RepoState struct

+ PublishedAt string

+ ReleaseID string

+ type SBOMFetcher interface

+ Fetch func(ctx tcontext.TransferMetadata, config *GithubConfig) (iterator.SBOMIterator, error)

+ type SequentialFetcher struct

+ func (f *SequentialFetcher) Fetch(ctx tcontext.TransferMetadata, config *GithubConfig) (iterator.SBOMIterator, error)

v0.0.5

Apr 29, 2025

v0.0.4

Apr 7, 2025

v0.0.3

Mar 20, 2025

Changes in this version

type Client

+ func (c *Client) FetchSBOMFromReleases(ctx tcontext.TransferMetadata) (VersionedSBOMs, error)

type GitHubAdapter

+ Daemon bool

+ ProcessingMode types.ProcessingMode

+ func (g *GitHubAdapter) Monitor(ctx tcontext.TransferMetadata) (iterator.SBOMIterator, tcontext.TransferMetadata, error)

v0.0.2

Feb 21, 2025

Changes in this version

type GitHubIterator

+ func (it *GitHubIterator) HandleSBOMFetchingViaIterator(ctx *tcontext.TransferMetadata, method GitHubMethod) error

v0.0.1

Feb 13, 2025

Changes in this version

+ var SupportedTools = map[string]string

+ func CloneRepoWithGit(ctx *tcontext.TransferMetadata, repoURL, branch, targetDir string) error

+ func GenerateSBOM(ctx *tcontext.TransferMetadata, repoDir, binaryPath string) (string, error)

+ func ParseGitHubURL(url string) (owner, repo string, err error)

+ type Asset struct

+ DownloadURL string

+ Name string

+ Size int

+ type Client struct

+ BaseURL string

+ Branch string

+ Method string

+ Organization string

+ Owner string

+ Repo string

+ RepoURL string

+ Token string

+ Version string

+ func NewClient(g *GitHubAdapter) *Client

+ func (c *Client) DownloadAsset(ctx *tcontext.TransferMetadata, downloadURL string) (io.ReadCloser, error)

+ func (c *Client) DownloadSBOM(ctx *tcontext.TransferMetadata, asset SBOMAsset) ([]byte, error)

+ func (c *Client) FetchSBOMFromAPI(ctx *tcontext.TransferMetadata) ([]byte, error)

+ func (c *Client) FindSBOMs(ctx *tcontext.TransferMetadata) ([]SBOMAsset, error)

+ func (c *Client) GetAllRepositories(ctx *tcontext.TransferMetadata) ([]string, error)

+ func (c *Client) GetReleases(ctx *tcontext.TransferMetadata, owner, repo string) ([]Release, error)

+ func (c *Client) GetSBOMs(ctx *tcontext.TransferMetadata) (VersionedSBOMs, error)

+ type GitHubAdapter struct

+ BinaryPath string

+ Branch string

+ ExcludeRepos []string

+ GithubToken string

+ IncludeRepos []string

+ Method string

+ Owner string

+ Repo string

+ Role types.AdapterRole

+ URL string

+ Version string

+ func (g *GitHubAdapter) AddCommandParams(cmd *cobra.Command)

+ func (g *GitHubAdapter) DryRun(ctx *tcontext.TransferMetadata, iterator iterator.SBOMIterator) error

+ func (g *GitHubAdapter) FetchSBOMs(ctx *tcontext.TransferMetadata) (iterator.SBOMIterator, error)

+ func (g *GitHubAdapter) ParseAndValidateParams(cmd *cobra.Command) error

+ func (g *GitHubAdapter) UploadSBOMs(ctx *tcontext.TransferMetadata, iterator iterator.SBOMIterator) error

+ type GitHubIterator struct

+ func NewGitHubIterator(ctx *tcontext.TransferMetadata, g *GitHubAdapter, repo string) (*GitHubIterator, error)

+ func (it *GitHubIterator) Next(ctx context.Context) (*iterator.SBOM, error)

+ type GitHubMethod string

+ const MethodAPI

+ const MethodReleases

+ const MethodTool

+ type GitHubSBOMResponse struct

+ SBOM json.RawMessage

+ type ProcessingMode string

+ const FetchParallel

+ const FetchSequential

+ type Release struct

+ Assets []Asset

+ TagName string

+ type SBOMAsset struct

+ DownloadURL string

+ Name string

+ Release string

+ Size int

+ type SBOMData struct

+ Content []byte

+ Filename string

+ type VersionedSBOMs map[string][]SBOMData

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL