github

Documentation

Overview

Package github provides a GitHub provider.

Index

• Constants
• func Delete(ctx context.Context, v *GitHub, secrets ...string) error
• type GitHub
  • func New(override, rawValue bool, owner, repo string) (*GitHub, error)
  • func (v *GitHub) GetRepository(ctx context.Context) (*Repository, error)
  • func (v *GitHub) Load(ctx context.Context, opts ...option.LoadKeyFunc) (map[string]string, error)
  • func (v *GitHub) Write(ctx context.Context, values map[string]interface{}, opts ...option.WriteFunc) error
• type PublicKeyResponse
• type Repository
• type SecretInformation
• type SecretRequest
• type SecretsResponse
  • func List(ctx context.Context, v *GitHub) (*SecretsResponse, error)
• type SecretsResponseSecret
• type Target
  • func (t Target) String() string
• type VariableRequest

Constants

const Name = "github"

Name of the provider.

Functions

func Delete

func Delete(ctx context.Context, v *GitHub, secrets ...string) error

Delete secrets.

Types

type GitHub

type GitHub struct {
	*provider.Provider `json:"-" validate:"required"`

	Owner string `json:"owner" validate:"required"`
	Repo  string `json:"repo"  validate:"required"`
	Token string `json:"-"     validate:"required"`
	// contains filtered or unexported fields
}

GitHub provider definition.

func New

func New(
	override, rawValue bool,
	owner, repo string,
) (*GitHub, error)

New returns a new GitHub provider.

func (*GitHub) GetRepository

func (v *GitHub) GetRepository(ctx context.Context) (*Repository, error)

GetRepository retrieves the repository information.

func (*GitHub) Load

func (v *GitHub) Load(ctx context.Context, opts ...option.LoadKeyFunc) (map[string]string, error)

Load retrieves the configuration, and exports it to the environment.

NOTE: Not all providers allow loading secrets, for example, GitHub. They are designed to be write-only stores of information. This is a security measure to prevent exposure of sensitive data.

func (*GitHub) Write

func (v *GitHub) Write(ctx context.Context, values map[string]interface{}, opts ...option.WriteFunc) error

Write stores a new secret.

NOTE: Not all providers support writing secrets.

type PublicKeyResponse

type PublicKeyResponse struct {
	Key   string `json:"key"`
	KeyID string `json:"key_id"`
}

PublicKeyResponse is the response from the GitHub API.

type Repository

type Repository struct {
	ID     int    `json:"id"`
	NodeID string `json:"node_id"`
}

Repository is the repository information.

type SecretInformation

type SecretInformation struct {
	MountPath  string `json:"-" validate:"required"`
	SecretPath string `json:"-" validate:"required"`
}

SecretInformation is the information about a secret, where to retrieve it.

type SecretRequest

type SecretRequest struct {
	EncryptedValue string `json:"encrypted_value"`
	KeyID          string `json:"key_id"`
}

SecretRequest is the request to store a new secret.

type SecretsResponse

type SecretsResponse struct {
	TotalCount int                     `json:"total_count"`
	Secrets    []SecretsResponseSecret `json:"secrets"`
}

SecretsResponse is the response from listing secrets.

func List

func List(ctx context.Context, v *GitHub) (*SecretsResponse, error)

List secrets.

type SecretsResponseSecret

type SecretsResponseSecret struct {
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

SecretsResponseSecret is the secret information from the GitHub API.

type Target

type Target string

Target of the request.

const (
	// Actions const.
	Actions Target = "actions"

	// Codespaces const.
	Codespaces Target = "codespaces"
)

func (Target) String

func (t Target) String() string

String implements the Stringer interface.

type VariableRequest

type VariableRequest struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

VariableRequest is the request to store a new secret.