github

Documentation

Overview

Package github contains logic relating to the management of github repos

Index

• Variables
• type RepositoryService
  • func NewRepositoryService(webhookManager webhooks.WebhookManager, store db.Store, ...) RepositoryService

Variables

var (
	// ErrPrivateRepoForbidden is returned when creation fails due to an
	// attempt to register a private repo in a project which does not allow
	// private repos
	ErrPrivateRepoForbidden = errors.New("private repos cannot be registered in this project")
)

Types

type RepositoryService

type RepositoryService interface {
	// CreateRepository registers a GitHub repository, including creating
	// a webhook in the repo in GitHub.
	CreateRepository(
		ctx context.Context,
		client ghclient.GitHubRepoClient,
		provider *db.Provider,
		projectID uuid.UUID,
		repoName string,
		repoOwner string,
	) (*pb.Repository, error)
	// DeleteRepository removes the webhook and deletes the repo from the database.
	DeleteRepository(
		ctx context.Context,
		client ghclient.GitHubRepoClient,
		repo *db.Repository,
	) error
	// GetRepositoryById retrieves a repository by its ID and project.
	GetRepositoryById(ctx context.Context, repositoryID uuid.UUID, projectID uuid.UUID) (db.Repository, error)
	// GetRepositoryByName retrieves a repository by its name, owner, project and provider (if specified).
	GetRepositoryByName(
		ctx context.Context,
		repoOwner string,
		repoName string,
		projectID uuid.UUID,
		providerName string,
	) (db.Repository, error)
	// DeleteRepositoriesByProvider cleans up the state (e.g. webhooks) for repositories associated with this provider
	DeleteRepositoriesByProvider(
		ctx context.Context,
		client ghclient.GitHubRepoClient,
		providerName string,
		projectID uuid.UUID,
	) error
}

RepositoryService encapsulates logic related to registering and deleting repos TODO: get rid of the github client from this interface

func NewRepositoryService

func NewRepositoryService(
	webhookManager webhooks.WebhookManager,
	store db.Store,
	eventProducer events.Publisher,
) RepositoryService

NewRepositoryService creates an instance of the RepositoryService interface