internal

package

v0.0.0-...-fd621cb Latest Latest Go to latest Published: May 20, 2020 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cirrus-actions/email

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NeutralExit()
func Parse(path string) (github.CheckSuiteEvent, github.Commit, error)
func Render(text string, data interface{}) (string, error)
func SendNotification(spec Specification)
type CheckSuiteExt
type Specification

Constants ¶

View Source

const DefauleEmailMarkdownTemplate = `
Check run [{{ .CheckRun.Name }}]({{ .CheckRun.HTMLURL }}) {{ .CheckRun.Status }} in {{ .Duration }}
`

View Source

const DefaultSubjectTemplate = `
{{.CheckSuite.App.Name}} check for {{.Repo.FullName}}#{{.CheckSuite.HeadBranch}} {{.CheckSuite.Status}}
`

Variables ¶

This section is empty.

Functions ¶

func NeutralExit ¶

func NeutralExit()

func Parse ¶

func Parse(path string) (github.CheckSuiteEvent, github.Commit, error)

func Render ¶

func Render(text string, data interface{}) (string, error)

func SendNotification ¶

func SendNotification(spec Specification)

Types ¶

type CheckSuiteExt ¶

type CheckSuiteExt struct {
	HeadCommit *github.Commit `json:"head_commit,omitempty"`
}

type Specification ¶

type Specification struct {
	AppName             string   `envconfig:"APP_NAME"`
	ConclusionsToIgnore []string `envconfig:"IGNORED_CONCLUSIONS" default:"success,neutral"`
	EventPath           string   `envconfig:"GITHUB_EVENT_PATH" required:"true"`
	GitHubToken         string   `envconfig:"GITHUB_TOKEN"`
	MailHost            string   `envconfig:"MAIL_HOST" required:"true"`
	MailPort            int      `envconfig:"MAIL_PORT" default:"587"`
	MailFrom            string   `envconfig:"MAIL_FROM" required:"true"`
	MailUsername        string   `envconfig:"MAIL_USERNAME" required:"true"`
	MailPassword        string   `envconfig:"MAIL_PASSWORD" required:"true"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL