github

README

Github

TODO

Documentation

Overview

Package github implements a sidecred.SecretStore on top of Github secrets.

Index

• func NewActionsStore(app App, options ...Option) sidecred.SecretStore
• func NewDependabotStore(app App, options ...Option) sidecred.SecretStore
• func NewStore(app App, options ...Option) sidecred.SecretStore
• type ActionsAPI
• type App
• type Option
  • func WithActionsClientFactory(f func(token string) ActionsAPI) Option
  • func WithSecretTemplate(t string) Option

Functions

func NewActionsStore

func NewActionsStore(app App, options ...Option) sidecred.SecretStore

func NewDependabotStore

func NewDependabotStore(app App, options ...Option) sidecred.SecretStore

func NewStore

func NewStore(app App, options ...Option) sidecred.SecretStore

NewStore creates a new sidecred.SecretStore using Github repository secrets.

Types

type ActionsAPI

type ActionsAPI interface {
	GetRepoPublicKey(ctx context.Context, owner, repo string) (*github.PublicKey, *github.Response, error)
	CreateOrUpdateRepoSecret(
		ctx context.Context,
		owner, repo string,
		eSecret *github.EncryptedSecret,
	) (*github.Response, error)
	GetRepoSecret(ctx context.Context, owner, repo, name string) (*github.Secret, *github.Response, error)
	DeleteRepoSecret(ctx context.Context, owner, repo, name string) (*github.Response, error)
}

ActionsAPI wraps the Github actions API.

type App

type App interface {
	CreateInstallationToken(owner string, repositories []string, permissions *githubapp.Permissions) (
		*githubapp.Token,
		error,
	)
}

App is the interface that needs to be satisfied by the Github App implementation.

type Option

type Option func(*store)

func WithActionsClientFactory

func WithActionsClientFactory(f func(token string) ActionsAPI) Option

WithActionsClientFactory sets the function used to create new installation clients, and can be used to return test fakes.

func WithSecretTemplate

func WithSecretTemplate(t string) Option

WithSecretTemplate sets the secret name template when instantiating a new store.