slack

package

v0.9.7 Latest Latest Go to latest Published: Mar 10, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func GenerateReleaseNotes(changelog map[string][]quoad.Commit, remote GitRemoter) []slack.Block

GenerateReleaseNotes creates a string from release notes that conforms with the Slack formatting. Expected format can be found in testdata.

type Block struct {
	Type     string    `json:"type"`
	Section  content   `json:"text,omitempty"`
	Elements []content `json:"elements,omitempty"`
}

Block holds the different blocks uses in the Slack block API Hmm... omitempty doesn't omit zero structs https://github.com/golang/go/issues/11939

type GitRemoter interface {
	GetRemoteURL() string
	Host() string
	Project() string
}

type Slack struct {
	WebHookURL string
}

Slack is the struct holding all the methods to work with the Slack integration.

func (s *Slack) Publish(commits map[string][]quoad.Commit, remote GitRemoter) error

Publish pushes the release notes to Slack via provided Webhook. https://api.slack.com/reference/messaging/payload

type WebhookMessage struct {
	Blocks []Block `json:"blocks"`
}

WebhookMessage is the specific structure that Slack uses for the Webhook API