1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +02:00
goreleaser/internal/pipe/slack/slack.go
Jamie Tanna 2a71473bf6
fix: Allow using double quotes for templates in Slack notifications (#4555)
As noted in #4556, when we're using a double quote, for use with a
template variable or function, we receive a template parse error as the
value needs to be unquoted.

This provides a slightly hacky solution which is to unquote any quoted
quotes.

Closes #4556.
2024-01-19 10:57:16 -03:00

121 lines
3.1 KiB
Go

package slack
import (
"encoding/json"
"fmt"
"strings"
"github.com/caarlos0/env/v9"
"github.com/caarlos0/log"
"github.com/goreleaser/goreleaser/internal/tmpl"
"github.com/goreleaser/goreleaser/pkg/context"
"github.com/slack-go/slack"
)
const (
defaultUsername = `GoReleaser`
defaultMessageTemplate = `{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .ReleaseURL }}`
)
type Pipe struct{}
func (Pipe) String() string { return "slack" }
func (Pipe) Skip(ctx *context.Context) bool { return !ctx.Config.Announce.Slack.Enabled }
type Config struct {
Webhook string `env:"SLACK_WEBHOOK,notEmpty"`
}
func (Pipe) Default(ctx *context.Context) error {
if ctx.Config.Announce.Slack.MessageTemplate == "" {
ctx.Config.Announce.Slack.MessageTemplate = defaultMessageTemplate
}
if ctx.Config.Announce.Slack.Username == "" {
ctx.Config.Announce.Slack.Username = defaultUsername
}
return nil
}
func (Pipe) Announce(ctx *context.Context) error {
msg, err := tmpl.New(ctx).Apply(ctx.Config.Announce.Slack.MessageTemplate)
if err != nil {
return fmt.Errorf("slack: %w", err)
}
var cfg Config
if err := env.Parse(&cfg); err != nil {
return fmt.Errorf("slack: %w", err)
}
log.Infof("posting: '%s'", msg)
// optional processing of advanced formatting options
blocks, attachments, err := parseAdvancedFormatting(ctx)
if err != nil {
return err
}
wm := &slack.WebhookMessage{
Username: ctx.Config.Announce.Slack.Username,
IconEmoji: ctx.Config.Announce.Slack.IconEmoji,
IconURL: ctx.Config.Announce.Slack.IconURL,
Channel: ctx.Config.Announce.Slack.Channel,
Text: msg,
// optional enrichments
Blocks: blocks,
Attachments: attachments,
}
err = slack.PostWebhook(cfg.Webhook, wm)
if err != nil {
return fmt.Errorf("slack: %w", err)
}
return nil
}
func parseAdvancedFormatting(ctx *context.Context) (*slack.Blocks, []slack.Attachment, error) {
var blocks *slack.Blocks
if in := ctx.Config.Announce.Slack.Blocks; len(in) > 0 {
blocks = &slack.Blocks{BlockSet: make([]slack.Block, 0, len(in))}
if err := unmarshal(ctx, in, blocks); err != nil {
return nil, nil, fmt.Errorf("slack blocks: %w", err)
}
}
var attachments []slack.Attachment
if in := ctx.Config.Announce.Slack.Attachments; len(in) > 0 {
attachments = make([]slack.Attachment, 0, len(in))
if err := unmarshal(ctx, in, &attachments); err != nil {
return nil, nil, fmt.Errorf("slack attachments: %w", err)
}
}
return blocks, attachments, nil
}
func unmarshal(ctx *context.Context, in interface{}, target interface{}) error {
jazon, err := json.Marshal(in)
if err != nil {
return fmt.Errorf("failed to marshal input as JSON: %w", err)
}
body := string(jazon)
// ensure that double quotes that are inside the string get un-escaped so they can be interpreted for templates
body = strings.ReplaceAll(body, "\\\"", "\"")
tplApplied, err := tmpl.New(ctx).Apply(body)
if err != nil {
return fmt.Errorf("failed to evaluate template: %w", err)
}
if err = json.Unmarshal([]byte(tplApplied), target); err != nil {
return fmt.Errorf("failed to unmarshal into target: %w", err)
}
return nil
}