config

Documentation

Index

• type AccessLevel
  • func (ac AccessLevel) String() string
• type AssignmentConfig
  • func GetAssignmentConfig(course, assignment string, onlyForStudentsOrGroups ...string) *AssignmentConfig
  • func (cfg *AssignmentConfig) RepoSuffix(student *Student) string
  • func (cfg *AssignmentConfig) SetAccessLevel(level string)
  • func (cfg *AssignmentConfig) SetBranch(branch string)
  • func (cfg *AssignmentConfig) SetForce()
  • func (cfg *AssignmentConfig) SetLocalpath(localpath string)
  • func (cfg *AssignmentConfig) SetProtectToBranch(branch string)
  • func (cfg *AssignmentConfig) Show()
  • func (cfg *AssignmentConfig) Urls(assignment bool)
• type Clone
• type CourseConfig
  • func GetCourseConfig(course string) *CourseConfig
• type Group
• type MergeRequest
• type Per
• type Release
• type Seeder
• type Startercode
• type Student

Types

type AccessLevel

type AccessLevel int

const (
	Guest      AccessLevel = 10
	Reporter   AccessLevel = 20
	Developer  AccessLevel = 30
	Maintainer AccessLevel = 40
)

func (AccessLevel) String

func (ac AccessLevel) String() string

type AssignmentConfig

type AssignmentConfig struct {
	Course            string
	Name              string
	Path              string
	URL               string
	Per               Per
	Description       string
	ContainerRegistry bool
	AccessLevel       AccessLevel
	Students          []*Student
	Groups            []*Group
	Startercode       *Startercode
	Clone             *Clone
	Release           *Release
	Seeder            *Seeder
}

func GetAssignmentConfig

func GetAssignmentConfig(course, assignment string, onlyForStudentsOrGroups ...string) *AssignmentConfig

func (*AssignmentConfig) RepoSuffix

func (cfg *AssignmentConfig) RepoSuffix(student *Student) string

Using email addresses instead of usernames/user-id's results in @ in the student's name. This is incompatible to the filesystem and gitlab so replacing the values is necessary.

func (*AssignmentConfig) SetAccessLevel

func (cfg *AssignmentConfig) SetAccessLevel(level string)

func (*AssignmentConfig) SetBranch

func (cfg *AssignmentConfig) SetBranch(branch string)

func (*AssignmentConfig) SetForce

func (cfg *AssignmentConfig) SetForce()

func (*AssignmentConfig) SetLocalpath

func (cfg *AssignmentConfig) SetLocalpath(localpath string)

func (*AssignmentConfig) SetProtectToBranch

func (cfg *AssignmentConfig) SetProtectToBranch(branch string)

func (*AssignmentConfig) Show

func (cfg *AssignmentConfig) Show()

func (*AssignmentConfig) Urls

func (cfg *AssignmentConfig) Urls(assignment bool)

type Clone

type Clone struct {
	LocalPath string
	Branch    string
	Force     bool
}

type CourseConfig

type CourseConfig struct {
	Course   string
	Students []*Student
	Groups   []*Group
}

func GetCourseConfig

func GetCourseConfig(course string) *CourseConfig

type Group

type Group struct {
	Name    string
	Members []*Student
}

type MergeRequest

type MergeRequest struct {
	SourceBranch string
	TargetBranch string
	HasPipeline  bool
}

type Per

type Per string

const (
	PerStudent Per = "student"
	PerGroup   Per = "group"
	PerFailed  Per = "could not happen"
)

type Release

type Release struct {
	MergeRequest *MergeRequest
	DockerImages []string
}

type Seeder

type Seeder struct {
	Command         string
	Args            []string
	Name            string
	EMail           string
	SignKey         *openpgp.Entity
	ToBranch        string
	ProtectToBranch bool
}

type Startercode

type Startercode struct {
	URL                string
	FromBranch         string
	ToBranch           string
	DevBranch          string
	AdditionalBranches []string
	ProtectToBranch    bool
}

type Student

type Student struct {
	Id       *int
	Username *string
	Email    *string
	Raw      string
}