slack

Documentation

Overview

Package slack is a package meant to help utilize the Slack API in GitHub actions.

Index

• func FindChannelID(channels []slack.Channel, name string) (string, error)
• func GetAllChannels(client *slack.Client) ([]slack.Channel, error)
• func Hyperlink(text, link string) string
• func JoinConversationContext(ctx context.Context, client *slack.Client, channelID string) error
• func Message(text string) slack.MsgOption
• func NewClient() (*slack.Client, error)
• func PostMessageContext(ctx context.Context, client *slack.Client, channelID, message string) error

Functions

func FindChannelID

func FindChannelID(channels []slack.Channel, name string) (string, error)

FindChannelID given a channel name, finds the channel id.

func GetAllChannels

func GetAllChannels(client *slack.Client) ([]slack.Channel, error)

GetAllChannels retrieves a list of all the available slack channels and retries once if needed.

func Hyperlink

func Hyperlink(text, link string) string

Hyperlink returns a hyperlink that be used in a slack message sent via the API.

func JoinConversationContext

func JoinConversationContext(ctx context.Context, client *slack.Client, channelID string) error

JoinConversationContext joins the specified slack channel and retries once if needed.

func Message

func Message(text string) slack.MsgOption

Message returns a message able to be posted via slack.*Client.PostMessage[Context].

func NewClient

func NewClient() (*slack.Client, error)

NewClient returns a new slack client configured with the token we expect to exist in the environment.

func PostMessageContext

func PostMessageContext(ctx context.Context, client *slack.Client, channelID, message string) error

PostMessageContext posts a message to the specified channel and retries if needed. Before trying to post, you need to make sure that you are part of channel by using JoinConversationContext.