healthcheck

Documentation

Index

• Constants
• func GithubIntegrationHealthcheck(cfg Config) (bool, error)
• func IsHealthy(ctx context.Context, client *github.Client, org string) error
• type Config
• type Details
• type HealthStatus
• type PermissionCheck

Constants

const (
	ReadPublicKey  = "read:public_key"
	ReadUser       = "read:user"
	ReadProject    = "read:project"
	RepoDeployment = "repo_deployment"
	ReadRepoHook   = "read:repo_hook"
	PublicRepo     = "public_repo"
	ReadOrg        = "read:org"
	RepoStatus     = "repo:status"
	ReadPackages   = "read:packages"
)

Define required permissions as constants

Functions

func GithubIntegrationHealthcheck

func GithubIntegrationHealthcheck(cfg Config) (bool, error)

func IsHealthy

func IsHealthy(ctx context.Context, client *github.Client, org string) error

IsHealthy checks if the PAT has read access to all required artifacts in the organization

Types

type Config

type Config struct {
	Token            string `json:"token"`
	OrganizationName string `json:"organization_name"`
}

Config represents the JSON input configuration

type Details

type Details struct {
	RequiredPermissions []string `json:"required_permissions"`
	MissingPermissions  []string `json:"missing_permissions"`
}

Details contains required and missing permissions

type HealthStatus

type HealthStatus struct {
	Organization string  `json:"organization"`
	Healthy      bool    `json:"healthy"`
	Details      Details `json:"details"`
}

HealthStatus represents the structure of the JSON output

type PermissionCheck

type PermissionCheck struct {
	Name  string
	Check func(ctx context.Context, client *github.Client, org string) error
}

PermissionCheck represents a permission and its corresponding check function