instructions

Documentation

Index

• type Processor
  • func New(assignmentPath string) *Processor
  • func NewWithDefaults(branch, assignmentPath string) *Processor
  • func (p *Processor) AddPullRequestLinkToReadme(content, repositoryName, branchName, prNumber string) string
  • func (p *Processor) AugmentExistingReadmeContent(existingContent string) string
  • func (p *Processor) CreateNewReadmeContent() string
  • func (p *Processor) CreatePullRequestBody() (string, error)

Types

type Processor

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

Processor handles reading and processing instruction files for a specific assignment

func New

func New(assignmentPath string) *Processor

New creates a new instructions processor for the given assignment path

func NewWithDefaults

func NewWithDefaults(branch, assignmentPath string) *Processor

NewWithDefaults creates a new instructions processor with branch and assignment path

func (*Processor) AddPullRequestLinkToReadme

func (p *Processor) AddPullRequestLinkToReadme(content, repositoryName, branchName, prNumber string) string

AddPullRequestLinkToReadme adds a pull request link to the top of README content

func (*Processor) AugmentExistingReadmeContent

func (p *Processor) AugmentExistingReadmeContent(existingContent string) string

AugmentExistingReadmeContent adds augmentation content to existing README content

func (*Processor) CreateNewReadmeContent

func (p *Processor) CreateNewReadmeContent() string

CreateNewReadmeContent creates content for a new README file

func (*Processor) CreatePullRequestBody

func (p *Processor) CreatePullRequestBody() (string, error)

CreatePullRequestBody creates pull request body content from the processor's assignment path