repos

Documentation

Index

• func RepoInSlice(repositories []RepoDetails, r string) bool
• type Commit
• type Readme
  • func (r *Readme) GithubActions() []string
  • func (r *Readme) LinkedCharm(ctx context.Context) *stores.Artifact
  • func (r *Readme) LinkedSnap(ctx context.Context) *stores.Artifact
• type Release
• type RepoDetails
• type Repository
• type Tag

Functions

func RepoInSlice

func RepoInSlice(repositories []RepoDetails, r string) bool

repoInSlice is a helper function to test if a given repo is already in a list of repos.

Types

type Commit

type Commit struct {
	Sha       string `json:"sha"`
	Author    string `json:"author"`
	Timestamp int64  `json:"timestamp"`
	Message   string `json:"message"`
	URL       string `json:"url"`
}

Commit represents a Git commit.

type Readme

type Readme struct {
	Body string
}

func (*Readme) GithubActions

func (r *Readme) GithubActions() []string

GithubActions tries to extract Github Actions Badges from the README.

func (*Readme) LinkedCharm

func (r *Readme) LinkedCharm(ctx context.Context) *stores.Artifact

LinkedCharm parses the Readme body, and returns a StoreArtifact representing a charm if there is a Charmhub.io badge in the Readme.

func (*Readme) LinkedSnap

func (r *Readme) LinkedSnap(ctx context.Context) *stores.Artifact

LinkedSnap parses the Readme body, and returns a StoreArtifact representing a snap if there is a Snapcraft.io badge in the Readme.

type Release

type Release struct {
	ID         int64  `json:"id"`
	Version    string `json:"version"`
	Timestamp  int64  `json:"timestamp"`
	Title      string `json:"title"`
	Body       string `json:"body"`
	URL        string `json:"url"`
	CompareURL string `json:"compareUrl"`
}

Release refers to either Github Release.

type RepoDetails

type RepoDetails struct {
	Name       string           `json:"name"`
	NewCommits int              `json:"newCommits"`
	URL        string           `json:"url"`
	Releases   []*Release       `json:"releases"`
	Tags       []*Tag           `json:"tags"`
	Commits    []*Commit        `json:"commits"`
	CiActions  []string         `json:"ciActions"`
	Charm      *stores.Artifact `json:"charm"`
	Snap       *stores.Artifact `json:"snap"`
}

RepoDetails represents the serialisable form of a Repository for the Report.

type Repository

type Repository interface {
	Process() error
}

Repository is an interface that provides common methods for different types of repository.

type Tag

type Tag struct {
	Name       string `json:"name"`
	Sha        string `json:"sha"`
	Body       string `json:"body"`
	Timestamp  int64  `json:"timestamp"`
	URL        string `json:"url"`
	CompareURL string `json:"compareUrl"`
}

Tag refers to a tag.