web_templates

Documentation

Index

• Variables
• type ApplyLockData
• type GithubSetupData
• type IndexData
• type LockDetailData
• type LockIndexData
• type ProjectJobData
• type ProjectJobsError
• type TemplateWriter

Variables

var GithubAppSetupTemplate = templates.Lookup(templateFileNames["github-app"])

var IndexTemplate = templates.Lookup(templateFileNames["index"])

var LockTemplate = templates.Lookup(templateFileNames["lock"])

var ProjectJobsErrorTemplate = templates.Lookup(templateFileNames["project-jobs-error"])

var ProjectJobsTemplate = templates.Lookup(templateFileNames["project-jobs"])

Types

type ApplyLockData

type ApplyLockData struct {
	Locked                 bool
	GlobalApplyLockEnabled bool
	Time                   time.Time
	TimeFormatted          string
}

ApplyLockData holds the fields to display in the index view

type GithubSetupData

type GithubSetupData struct {
	Target          string
	Manifest        string
	ID              int64
	Key             string
	WebhookSecret   string
	URL             string
	CleanedBasePath string
}

GithubSetupData holds the data for rendering the github app setup page

type IndexData

type IndexData struct {
	Locks            []LockIndexData
	PullToJobMapping []jobs.PullInfoWithJobIDs

	ApplyLock       ApplyLockData
	AtlantisVersion string
	// CleanedBasePath is the path Atlantis is accessible at externally. If
	// not using a path-based proxy, this will be an empty string. Never ends
	// in a '/' (hence "cleaned").
	CleanedBasePath string
}

IndexData holds the data for rendering the index page

type LockDetailData

type LockDetailData struct {
	LockKeyEncoded  string
	LockKey         string
	RepoOwner       string
	RepoName        string
	PullRequestLink string
	LockedBy        string
	Workspace       string
	AtlantisVersion string
	// CleanedBasePath is the path Atlantis is accessible at externally. If
	// not using a path-based proxy, this will be an empty string. Never ends
	// in a '/' (hence "cleaned").
	CleanedBasePath string
}

LockDetailData holds the fields needed to display the lock detail view.

type LockIndexData

type LockIndexData struct {
	LockPath      string
	RepoFullName  string
	PullNum       int
	Path          string
	Workspace     string
	LockedBy      string
	Time          time.Time
	TimeFormatted string
}

LockIndexData holds the fields needed to display the index view for locks.

type ProjectJobData

type ProjectJobData struct {
	AtlantisVersion string
	ProjectPath     string
	CleanedBasePath string
}

ProjectJobData holds the data needed to stream the current PR information

type ProjectJobsError

type ProjectJobsError struct {
	AtlantisVersion string
	ProjectPath     string
	CleanedBasePath string
}

type TemplateWriter

type TemplateWriter interface {
	// Execute applies a parsed template to the specified data object,
	// writing the output to wr.
	Execute(wr io.Writer, data interface{}) error
}

TemplateWriter is an interface over html/template that's used to enable mocking.