-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[release tool] Slack notifications (#9668)
* slack notifications * allow setting debug via env var * cleanups * address review feedback * Compile product name into binary * use constant instead of ldflag
- Loading branch information
Showing
18 changed files
with
444 additions
and
236 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| // Copyright (c) 2024-2025 Tigera, Inc. All rights reserved. | ||
|
|
||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package slack | ||
|
|
||
| import ( | ||
| "bytes" | ||
| _ "embed" | ||
| "fmt" | ||
| "html/template" | ||
|
|
||
| "github.com/sirupsen/logrus" | ||
| "github.com/slack-go/slack" | ||
|
|
||
| "github.com/projectcalico/calico/release/internal/registry" | ||
| ) | ||
|
|
||
| var ( | ||
| //go:embed templates/hashrelease-published.json.gotmpl | ||
| publishedMessageTemplateData string | ||
| //go:embed templates/failure.json.gotmpl | ||
| failureMessageTemplateData string | ||
| //go:embed templates/missing-images.json.gotmpl | ||
| missingImagesMessageTemplateData string | ||
| ) | ||
|
|
||
| // BaseMessageData contains the common fields for all messages. | ||
| type BaseMessageData struct { | ||
| ReleaseName string | ||
| Product string | ||
| Stream string | ||
| ProductVersion string | ||
| OperatorVersion string | ||
| ReleaseType string | ||
| CIURL string | ||
| } | ||
|
|
||
| // HashreleasePublishedMessageData contains the fields for sending a message about a hashrelease being published. | ||
| type HashreleasePublishedMessageData struct { | ||
| BaseMessageData | ||
| DocsURL string | ||
| ImageScanResultURL string | ||
| } | ||
|
|
||
| // MissingImagesMessageData contains the fields for sending a message about missing images. | ||
| type MissingImagesMessageData struct { | ||
| BaseMessageData | ||
| MissingImages []registry.Component | ||
| } | ||
|
|
||
| // FailureMessageData contains the fields for sending a message about a failure. | ||
| type FailureMessageData struct { | ||
| BaseMessageData | ||
| Error string | ||
| } | ||
|
|
||
| // PostHashreleaseAnnouncement sends a message to slack about a hashrelease being published. | ||
| func PostHashreleaseAnnouncement(cfg *Config, msg *HashreleasePublishedMessageData) error { | ||
| message, err := renderMessage(publishedMessageTemplateData, msg) | ||
| if err != nil { | ||
| logrus.WithError(err).Error("Failed to render message") | ||
| return err | ||
| } | ||
| return sendToSlack(cfg, message) | ||
| } | ||
|
|
||
| // PostMissingImagesMessage sends a message to slack about missing images. | ||
| func PostMissingImagesMessage(cfg *Config, msg *MissingImagesMessageData) error { | ||
| message, err := renderMessage(missingImagesMessageTemplateData, msg) | ||
| if err != nil { | ||
| logrus.WithError(err).Error("Failed to render message") | ||
| return err | ||
| } | ||
| return sendToSlack(cfg, message) | ||
| } | ||
|
|
||
| // PostFailureMessage sends a message to slack about a failure. | ||
| func PostFailureMessage(cfg *Config, msg *FailureMessageData) error { | ||
| message, err := renderMessage(failureMessageTemplateData, msg) | ||
| if err != nil { | ||
| logrus.WithError(err).Error("Failed to render message") | ||
| return err | ||
| } | ||
| return sendToSlack(cfg, message) | ||
| } | ||
|
|
||
| // renderMessage renders a message template with the provided data. | ||
| func renderMessage(text string, data any) ([]slack.Block, error) { | ||
| tmpl, err := template.New("message").Parse(text) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| if err := tmpl.Execute(&buf, data); err != nil { | ||
| return nil, err | ||
| } | ||
| blocks := slack.Blocks{} | ||
| if err := blocks.UnmarshalJSON(buf.Bytes()); err != nil { | ||
| return nil, err | ||
| } | ||
| return blocks.BlockSet, nil | ||
| } | ||
|
|
||
| // sendToSlack sends a message to slack. | ||
| func sendToSlack(cfg *Config, message []slack.Block) error { | ||
| if cfg == nil { | ||
| return fmt.Errorf("no configuration provided") | ||
| } | ||
| if !cfg.Valid() { | ||
| return fmt.Errorf("invalid or missing configuration") | ||
| } | ||
|
|
||
| client := slack.New(cfg.Token, slack.OptionDebug(logrus.IsLevelEnabled(logrus.DebugLevel))) | ||
| _, _, err := client.PostMessage(cfg.Channel, slack.MsgOptionBlocks(message...)) | ||
| return err | ||
| } |
Oops, something went wrong.