cmd

Documentation

Index

• Constants
• func AddChildrenFlag(cmd *cobra.Command)
• func AddGroupFlag(cmd *cobra.Command)
• func AddPolicyFileFlag(cmd *cobra.Command)
• func AddRepositoriesFileFlag(cmd *cobra.Command)
• func Execute()
• type LicenseRule
• type PolicyError
  • func (this PolicyError) Error() string
• type PolicyFile
• type Repo
• type RepositoriesFile
  • func (this RepositoriesFile) Group(groupName string) (*RepositoryGroup, error)
  • func (this *RepositoriesFile) RepositoriesByGroup(group string) []RepositoryDefinition
• type RepositoryDefinition
• type RepositoryGroup
  • func (this *RepositoryGroup) Add(repoDef RepositoryDefinition)
  • func (this *RepositoryGroup) GetRepositories(listChildren bool) []RepositoryDefinition
  • func (this *RepositoryGroup) HasChildren() bool
  • func (this *RepositoryGroup) ListRepositories(listChildren bool) []string
• type UserPermission

Constants

const (
	ERR_ACCESS_MISSING    = "The repository %s doesn't have the user."
	ERR_ACCESS_WRONG      = "The repository %s's user's permission is incorrect."
	ERR_BRANCH_DEFAULT    = "The default branch should be '%s', not '%s'."
	ERR_LABEL_EXTRA       = "The label '%s' is present and shouldn't be."
	ERR_LABEL_MISSING     = "The label '%s' is missing."
	ERR_LICENSE_DIFFERENT = "The license should be one of '%s', not '%s'."
	ERR_LICENSE_MISSING   = "The license is missing."
	ERR_CO_DIFFERENT      = "The CODEOWNERS file is different from the policy."
	ERR_CO_MISSING        = "The CODEOWNERS file is missing."
	ERR_CO_SYNTAX         = "The CODEOWNERS file has syntax errors:\n%s"
)

Functions

func AddChildrenFlag

func AddChildrenFlag(cmd *cobra.Command)

func AddGroupFlag

func AddGroupFlag(cmd *cobra.Command)

func AddPolicyFileFlag

func AddPolicyFileFlag(cmd *cobra.Command)

func AddRepositoriesFileFlag

func AddRepositoriesFileFlag(cmd *cobra.Command)

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately.

Types

type LicenseRule

type LicenseRule struct {
	Scope string   `yaml:"scope"`
	Names []string `yaml:"names"`
}

type PolicyError

type PolicyError struct {
	// contains filtered or unexported fields
}

Represents a error when applying a policy, with contextual information.

func (PolicyError) Error

func (this PolicyError) Error() string

Properly print out a policy error.

type PolicyFile

type PolicyFile struct {
	DefaultBranch  string           `yaml:"defaultBranch"`
	Archived       bool             `yaml:"archived"` // include archived repos in lookup?
	License        *LicenseRule     `yaml:"license"`
	Labels         []string         `yaml:"labels"`
	LabelStrategy  string           `yaml:"labelStrategy"`
	Access         []UserPermission `yaml:"access"`
	AccessStrategy string           `yaml:"accessStrategy"`
	CodeOwners     string           `yaml:"codeowners"`
}

type Repo

type Repo struct {
	// contains filtered or unexported fields
}

type RepositoriesFile

type RepositoriesFile []*RepositoryGroup

============================================================================= A repositories.yml file =============================================================================

func (RepositoriesFile) Group

func (this RepositoriesFile) Group(groupName string) (*RepositoryGroup, error)

Get a group from a repositories file.

func (*RepositoriesFile) RepositoriesByGroup

func (this *RepositoriesFile) RepositoriesByGroup(group string) []RepositoryDefinition

Gets repositories from a repositories.yml file by group. The only group supported at this time is 'all'.

type RepositoryDefinition

type RepositoryDefinition struct {
	URL  string   `yaml:"url"`
	Tags []string `yaml:"tags,omitempty"`
}

type RepositoryGroup

type RepositoryGroup struct {
	Group        string                 `yaml:"group"`
	Repositories []RepositoryDefinition `yaml:"repositories"`
	Children     RepositoriesFile       `yaml:"children,omitempty"`
}

============================================================================= A list of repositories belonging to a group, the top-level object in a repositories.yml file. =============================================================================

func (*RepositoryGroup) Add

func (this *RepositoryGroup) Add(repoDef RepositoryDefinition)

Add a repository to the group

func (*RepositoryGroup) GetRepositories

func (this *RepositoryGroup) GetRepositories(listChildren bool) []RepositoryDefinition

Returns the repositories belong to the group. The parameter decides if to include children or not.

func (*RepositoryGroup) HasChildren

func (this *RepositoryGroup) HasChildren() bool

func (*RepositoryGroup) ListRepositories

func (this *RepositoryGroup) ListRepositories(listChildren bool) []string

Returns the list of URLs for each repository in this group. The parameter decides if to include children or not.

type UserPermission

type UserPermission struct {
	Username   string `yaml:"user"`
	Permission string `yaml:"permission"`
}