template

Documentation

Index

• func CouldBe(filename string) bool
• func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string
• func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error)
• func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplate, error)
• func UnmarshalFromEntry(entry *git.TreeEntry, dir string) (*api.IssueTemplate, error)
• func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.IssueTemplate, error)
• func Validate(template *api.IssueTemplate) error

Functions

func CouldBe

func CouldBe(filename string) bool

CouldBe indicates a file with the filename could be a template, it is a low cost check before further processing.

func RenderToMarkdown

func RenderToMarkdown(template *api.IssueTemplate, values url.Values) string

RenderToMarkdown renders template to markdown with specified values

func Unmarshal

func Unmarshal(filename string, content []byte) (*api.IssueTemplate, error)

Unmarshal parses out a valid template from the content

func UnmarshalFromCommit

func UnmarshalFromCommit(commit *git.Commit, filename string) (*api.IssueTemplate, error)

UnmarshalFromCommit parses out a valid template from the commit

func UnmarshalFromEntry

func UnmarshalFromEntry(entry *git.TreeEntry, dir string) (*api.IssueTemplate, error)

UnmarshalFromEntry parses out a valid template from the blob in entry

func UnmarshalFromRepo

func UnmarshalFromRepo(repo *git.Repository, branch, filename string) (*api.IssueTemplate, error)

UnmarshalFromRepo parses out a valid template from the head commit of the branch

func Validate

func Validate(template *api.IssueTemplate) error

Validate checks whether an IssueTemplate is considered valid, and returns the first error