feishu_plugin

package

v1.16.0 Latest Latest Go to latest Published: Sep 25, 2023 License: Apache-2.0 Imports: 19 Imported by: 2

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

Repository

github.com/sinlov/drone-feishu-group-robot

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CommonFlag() []cli.Flag
func Flag() []cli.Flag
func HideFlag() []cli.Flag
func IsBuildDebugOpen(c *cli.Context) bool
func RenderFeishuCard(tpl string, p *FeishuPlugin) (string, error)
type CardOss
type Config
type FeishuPlugin
- func BindFlag(c *cli.Context, cliVersion, cliName string, drone drone_info.Drone) FeishuPlugin
- func (p *FeishuPlugin) Exec() error
type SendTarget

Constants ¶

View Source

const (
	NamePluginDebug   = "config.debug"
	EnvPluginTimeOut  = "PLUGIN_TIMEOUT_SECOND"
	NamePluginTimeOut = "config.timeout_second"

	RenderStatusShow = "success"
	RenderStatusHide = "failure"

	MsgTypeText        = "text"
	MsgTypePost        = "post"
	MsgTypeInteractive = "interactive"
)

View Source

const (
	EnvDroneSystemAdminToken = "PLUGIN_DRONE_SYSTEM_ADMIN_TOKEN"

	EnvPluginFeishuIgnoreLastSuccessByAdminTokenDistance = "PLUGIN_FEISHU_IGNORE_LAST_SUCCESS_BY_ADMIN_TOKEN_DISTANCE"
	EnvPluginFeishuIgnoreLastSuccessByBadges             = "PLUGIN_FEISHU_IGNORE_LAST_SUCCESS_BY_BADGES"
	EnvPluginFeishuIgnoreLastSuccessBranch               = "PLUGIN_FEISHU_IGNORE_LAST_SUCCESS_BRANCH"
	EnvPluginFeishuWebhook                               = "PLUGIN_FEISHU_WEBHOOK"
	EnvPluginFeishuSecret                                = "PLUGIN_FEISHU_SECRET"
	EnvPluginFeishuMsgTitle                              = "PLUGIN_FEISHU_MSG_TITLE"
	EnvPluginFeishuEnableForward                         = "PLUGIN_FEISHU_ENABLE_FORWARD"
	EnvPluginFeishuMsgType                               = "PLUGIN_FEISHU_MSG_TYPE"
	EnvPluginFeishuMsgPoweredByImageKey                  = "PLUGIN_FEISHU_MSG_POWERED_BY_IMAGE_KEY"
	EnvPluginFeishuMsgPoweredByImageAlt                  = "PLUGIN_FEISHU_MSG_POWERED_BY_IMAGE_ALT"

	EnvPluginFeishuOssHost           = "PLUGIN_FEISHU_OSS_HOST"
	EnvPluginFeishuOssInfoSendResult = "PLUGIN_FEISHU_OSS_INFO_SEND_RESULT"
	EnvPluginFeishuOssInfoUser       = "PLUGIN_FEISHU_OSS_INFO_USER"
	EnvPluginFeishuOssInfoPath       = "PLUGIN_FEISHU_OSS_INFO_PATH"
	EnvPluginFeishuOssResourceUrl    = "PLUGIN_FEISHU_OSS_RESOURCE_URL"
	EnvPluginFeishuOssPageUrl        = "PLUGIN_FEISHU_OSS_PAGE_URL"
	EnvPluginFeishuOssPagePasswd     = "PLUGIN_FEISHU_OSS_PAGE_PASSWD"
)

View Source

const DefaultCardTemplate string = `` /* 4140-byte string literal not displayed */

DefaultCardTemplate use FeishuPlugin and feishu_message.FeishuRobotMsgTemplate

Variables ¶

This section is empty.

Functions ¶

func CommonFlag ¶ added in v1.5.0

func CommonFlag() []cli.Flag

CommonFlag Other modules also have flags

func Flag ¶ added in v1.5.0

func Flag() []cli.Flag

Flag set plugin flag at here

func HideFlag ¶ added in v1.5.0

func HideFlag() []cli.Flag

HideFlag hide flags

func IsBuildDebugOpen ¶ added in v1.12.0

func IsBuildDebugOpen(c *cli.Context) bool

IsBuildDebugOpen when config or drone build open debug will open debug

func RenderFeishuCard ¶

func RenderFeishuCard(tpl string, p *FeishuPlugin) (string, error)

Types ¶

type CardOss ¶ added in v1.2.0

type CardOss struct {
	Host string

	// HeadTemplateStyle
	// @doc https://open.feishu.cn/document/common-capabilities/message-card/message-cards-content/card-header
	HeadTemplateStyle string

	// InfoTagResult
	// tag result [ success or failure]
	InfoTagResult string
	// InfoSendResult
	// send result [ success or failure]
	InfoSendResult string

	// pull request [ success or failure]
	InfoPullRequestResult string

	InfoUser string
	InfoPath string

	RenderResourceUrl string
	ResourceUrl       string
	PageUrl           string
	PagePasswd        string
}

type Config ¶

type Config struct {
	Debug                 bool
	DroneSystemAdminToken string
	NtpTarget             string
	Webhook               string
	Secret                string
	FeishuEnableForward   bool
	TimeoutSecond         int
	MsgType               string
	Title                 string
	PoweredByImageKey     string
	PoweredByImageAlt     string

	IgnoreLastSuccessByAdminTokenDistance uint

	IgnoreLastSuccessByBadges     bool
	IgnoreLastSuccessBadgesBranch string

	RenderOssCard string
	CardOss       CardOss
}

Config plugin private config

type FeishuPlugin ¶ added in v1.2.0

type FeishuPlugin struct {
	Name                   string
	Version                string
	Drone                  drone_info.Drone
	Config                 Config
	SendTarget             SendTarget
	FeishuRobotMsgTemplate feishu_message.FeishuRobotMsgTemplate
	// contains filtered or unexported fields
}

FeishuPlugin plugin all config

func BindFlag ¶ added in v1.5.0

func BindFlag(c *cli.Context, cliVersion, cliName string, drone drone_info.Drone) FeishuPlugin

func (*FeishuPlugin) Exec ¶ added in v1.2.0

func (p *FeishuPlugin) Exec() error

type SendTarget ¶

type SendTarget struct {
	Webhook        string
	Secret         string
	FeishuRobotMeg []byte
}

SendTarget send feishu target

Source Files ¶

View all Source files

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