plugin

package

Go to main page

Versions in this module

v1

v1.3.10

Dec 12, 2025

v1.3.9

Dec 12, 2025

v1.3.8

Dec 12, 2025

Changes in this version

type ArtifactProto

+ func (m *ArtifactProto) ProtoMessage()

+ func (m *ArtifactProto) Reset()

+ func (m *ArtifactProto) String() string

type CategorizedChangesProto

+ func (m *CategorizedChangesProto) ProtoMessage()

+ func (m *CategorizedChangesProto) Reset()

+ func (m *CategorizedChangesProto) String() string

type ConventionalCommitProto

+ func (m *ConventionalCommitProto) ProtoMessage()

+ func (m *ConventionalCommitProto) Reset()

+ func (m *ConventionalCommitProto) String() string

type Empty

+ func (m *Empty) ProtoMessage()

+ func (m *Empty) Reset()

+ func (m *Empty) String() string

type ExecuteRequestProto

+ func (m *ExecuteRequestProto) ProtoMessage()

+ func (m *ExecuteRequestProto) Reset()

+ func (m *ExecuteRequestProto) String() string

type ExecuteResponseProto

+ func (m *ExecuteResponseProto) ProtoMessage()

+ func (m *ExecuteResponseProto) Reset()

+ func (m *ExecuteResponseProto) String() string

type PluginInfo

+ func (m *PluginInfo) ProtoMessage()

+ func (m *PluginInfo) Reset()

+ func (m *PluginInfo) String() string

type ReleaseContextProto

+ func (m *ReleaseContextProto) ProtoMessage()

+ func (m *ReleaseContextProto) Reset()

+ func (m *ReleaseContextProto) String() string

type ValidateRequestProto

+ func (m *ValidateRequestProto) ProtoMessage()

+ func (m *ValidateRequestProto) Reset()

+ func (m *ValidateRequestProto) String() string

type ValidateResponseProto

+ func (m *ValidateResponseProto) ProtoMessage()

+ func (m *ValidateResponseProto) Reset()

+ func (m *ValidateResponseProto) String() string

type ValidationErrorProto

+ func (m *ValidationErrorProto) ProtoMessage()

+ func (m *ValidationErrorProto) Reset()

+ func (m *ValidationErrorProto) String() string

v1.3.7

Dec 12, 2025

v1.3.6

Dec 12, 2025

v1.3.5

Dec 12, 2025

v1.3.4

Dec 12, 2025

v1.3.3

Dec 12, 2025

v1.3.2

Dec 12, 2025

v1.3.1

Dec 12, 2025

v1.3.0

Dec 12, 2025

v1.2.4

Dec 12, 2025

v1.2.3

Dec 12, 2025

v1.2.2

Dec 12, 2025

v1.2.1

Dec 12, 2025

v1.2.0

Dec 11, 2025

v1.1.0

Dec 11, 2025

Changes in this version

type ConfigParser

+ func (p *ConfigParser) GetStringDefault(field string, defaultVal string, envVars ...string) string

type ValidationBuilder

+ func (vb *ValidationBuilder) AddWarning(field, message string) *ValidationBuilder

+ func (vb *ValidationBuilder) Warnings() []string

v1.0.0

Dec 11, 2025

v0

v0.2.1

Dec 11, 2025

v0.2.0

Dec 11, 2025

v0.1.0

Dec 11, 2025

Changes in this version

+ const MagicCookieKey

+ const MagicCookieValue

+ const PluginName

+ var Handshake = plugin.HandshakeConfig

+ var PluginMap = map[string]plugin.Plugin

+ func BuildMentionText(mentions []string, format MentionFormat) string

+ func IsPlugin() bool

+ func RegisterPluginServer(s *grpc.Server, srv PluginServer)

+ func Serve(impl Plugin)

+ func ServeTest(impl Plugin) (*plugin.ReattachConfig, func())

+ func ValidateAssetPath(assetPath string) (string, error)

+ type Artifact struct

+ Checksum string

+ Name string

+ Path string

+ Size int64

+ Type string

+ type ArtifactProto struct

+ Checksum string

+ Name string

+ Path string

+ Size int64

+ Type string

+ type CategorizedChanges struct

+ Breaking []ConventionalCommit

+ Docs []ConventionalCommit

+ Features []ConventionalCommit

+ Fixes []ConventionalCommit

+ Other []ConventionalCommit

+ Performance []ConventionalCommit

+ Refactor []ConventionalCommit

+ type CategorizedChangesProto struct

+ Breaking []*ConventionalCommitProto

+ Docs []*ConventionalCommitProto

+ Features []*ConventionalCommitProto

+ Fixes []*ConventionalCommitProto

+ Other []*ConventionalCommitProto

+ Performance []*ConventionalCommitProto

+ Refactor []*ConventionalCommitProto

+ type ConfigParser struct

+ func NewConfigParser(config map[string]any) *ConfigParser

+ func (p *ConfigParser) GetBool(field string) bool

+ func (p *ConfigParser) GetBoolDefault(field string, defaultVal bool) bool

+ func (p *ConfigParser) GetFloat(field string) float64

+ func (p *ConfigParser) GetInt(field string) int

+ func (p *ConfigParser) GetIntDefault(field string, defaultVal int) int

+ func (p *ConfigParser) GetString(field string, envVars ...string) string

+ func (p *ConfigParser) GetStringMap(field string) map[string]string

+ func (p *ConfigParser) GetStringSlice(field string) []string

+ func (p *ConfigParser) Has(field string) bool

+ func (p *ConfigParser) Raw() map[string]any

+ type ConventionalCommit struct

+ Author string

+ Body string

+ Breaking bool

+ BreakingDescription string

+ Date string

+ Description string

+ Hash string

+ Issues []string

+ Scope string

+ Type string

+ type ConventionalCommitProto struct

+ Author string

+ Body string

+ Breaking bool

+ BreakingDescription string

+ Date string

+ Description string

+ Hash string

+ Issues []string

+ Scope string

+ Type string

+ type Empty struct

+ type ExecuteRequest struct

+ Config map[string]any

+ Context ReleaseContext

+ DryRun bool

+ Hook Hook

+ type ExecuteRequestProto struct

+ Config string

+ Context *ReleaseContextProto

+ DryRun bool

+ Hook HookProto

+ type ExecuteResponse struct

+ Artifacts []Artifact

+ Error string

+ Message string

+ Outputs map[string]any

+ Success bool

+ type ExecuteResponseProto struct

+ Artifacts []*ArtifactProto

+ Error string

+ Message string

+ Outputs string

+ Success bool

+ type GRPCClient struct

+ func (c *GRPCClient) Execute(ctx context.Context, req ExecuteRequest) (*ExecuteResponse, error)

+ func (c *GRPCClient) GetInfo() Info

+ func (c *GRPCClient) Validate(ctx context.Context, config map[string]any) (*ValidateResponse, error)

+ type GRPCPlugin struct

+ Impl Plugin

+ func (p *GRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type GRPCServer struct

+ Impl Plugin

+ func (s *GRPCServer) Execute(ctx context.Context, req *ExecuteRequestProto) (*ExecuteResponseProto, error)

+ func (s *GRPCServer) GetInfo(ctx context.Context, req *Empty) (*PluginInfo, error)

+ func (s *GRPCServer) Validate(ctx context.Context, req *ValidateRequestProto) (*ValidateResponseProto, error)

+ type Hook string

+ const HookOnError

+ const HookOnSuccess

+ const HookPostApprove

+ const HookPostInit

+ const HookPostNotes

+ const HookPostPlan

+ const HookPostPublish

+ const HookPostVersion

+ const HookPreApprove

+ const HookPreInit

+ const HookPreNotes

+ const HookPrePlan

+ const HookPrePublish

+ const HookPreVersion

+ func AllHooks() []Hook

+ type HookProto int32

+ const HookProto_HOOK_ON_ERROR

+ const HookProto_HOOK_ON_SUCCESS

+ const HookProto_HOOK_POST_APPROVE

+ const HookProto_HOOK_POST_INIT

+ const HookProto_HOOK_POST_NOTES

+ const HookProto_HOOK_POST_PLAN

+ const HookProto_HOOK_POST_PUBLISH

+ const HookProto_HOOK_POST_VERSION

+ const HookProto_HOOK_PRE_APPROVE

+ const HookProto_HOOK_PRE_INIT

+ const HookProto_HOOK_PRE_NOTES

+ const HookProto_HOOK_PRE_PLAN

+ const HookProto_HOOK_PRE_PUBLISH

+ const HookProto_HOOK_PRE_VERSION

+ const HookProto_HOOK_UNSPECIFIED

+ type Info struct

+ Author string

+ ConfigSchema string

+ Description string

+ Hooks []Hook

+ Name string

+ Version string

+ type MentionFormat int

+ const MentionFormatDiscord

+ const MentionFormatPlain

+ const MentionFormatSlack

+ type Plugin interface

+ Execute func(ctx context.Context, req ExecuteRequest) (*ExecuteResponse, error)

+ GetInfo func() Info

+ Validate func(ctx context.Context, config map[string]any) (*ValidateResponse, error)

+ type PluginClient interface

+ Execute func(ctx context.Context, in *ExecuteRequestProto, opts ...grpc.CallOption) (*ExecuteResponseProto, error)

+ GetInfo func(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*PluginInfo, error)

+ Validate func(ctx context.Context, in *ValidateRequestProto, opts ...grpc.CallOption) (*ValidateResponseProto, error)

+ func NewPluginClient(cc grpc.ClientConnInterface) PluginClient

+ type PluginInfo struct

+ Author string

+ ConfigSchema string

+ Description string

+ Hooks []string

+ Name string

+ Version string

+ type PluginServer interface

+ Execute func(context.Context, *ExecuteRequestProto) (*ExecuteResponseProto, error)

+ GetInfo func(context.Context, *Empty) (*PluginInfo, error)

+ Validate func(context.Context, *ValidateRequestProto) (*ValidateResponseProto, error)

+ type ReleaseContext struct

+ Branch string

+ Changelog string

+ Changes *CategorizedChanges

+ CommitSHA string

+ Environment map[string]string

+ PreviousVersion string

+ ReleaseNotes string

+ ReleaseType string

+ RepositoryName string

+ RepositoryOwner string

+ RepositoryURL string

+ TagName string

+ Version string

+ type ReleaseContextProto struct

+ Branch string

+ Changelog string

+ Changes *CategorizedChangesProto

+ CommitSha string

+ Environment map[string]string

+ PreviousVersion string

+ ReleaseNotes string

+ ReleaseType string

+ RepositoryName string

+ RepositoryOwner string

+ RepositoryUrl string

+ TagName string

+ Version string

+ type URLValidator struct

+ func NewURLValidator(scheme string) *URLValidator

+ func (uv *URLValidator) Validate(urlString string) error

+ func (uv *URLValidator) WithHosts(hosts ...string) *URLValidator

+ func (uv *URLValidator) WithPathPrefix(prefix string) *URLValidator

+ type UnimplementedPluginServer struct

+ func (UnimplementedPluginServer) Execute(context.Context, *ExecuteRequestProto) (*ExecuteResponseProto, error)

+ func (UnimplementedPluginServer) GetInfo(context.Context, *Empty) (*PluginInfo, error)

+ func (UnimplementedPluginServer) Validate(context.Context, *ValidateRequestProto) (*ValidateResponseProto, error)

+ type ValidateRequestProto struct

+ Config string

+ type ValidateResponse struct

+ Errors []ValidationError

+ Valid bool

+ type ValidateResponseProto struct

+ Errors []*ValidationErrorProto

+ Valid bool

+ type ValidationBuilder struct

+ func NewValidationBuilder() *ValidationBuilder

+ func (vb *ValidationBuilder) AddEnumError(field string, validValues []string) *ValidationBuilder

+ func (vb *ValidationBuilder) AddError(field, message, code string) *ValidationBuilder

+ func (vb *ValidationBuilder) AddFormatError(field, message string) *ValidationBuilder

+ func (vb *ValidationBuilder) AddRequired(field string) *ValidationBuilder

+ func (vb *ValidationBuilder) AddTypeError(field, expectedType string) *ValidationBuilder

+ func (vb *ValidationBuilder) Build() *ValidateResponse

+ func (vb *ValidationBuilder) Errors() []ValidationError

+ func (vb *ValidationBuilder) HasErrors() bool

+ func (vb *ValidationBuilder) RequireString(config map[string]any, field string) *ValidationBuilder

+ func (vb *ValidationBuilder) RequireStringWithEnv(config map[string]any, field string, envVars ...string) *ValidationBuilder

+ func (vb *ValidationBuilder) ValidateEnum(config map[string]any, field string, validValues []string) *ValidationBuilder

+ func (vb *ValidationBuilder) ValidateRegex(config map[string]any, field string) *ValidationBuilder

+ func (vb *ValidationBuilder) ValidateStringSlice(config map[string]any, field string) *ValidationBuilder

+ func (vb *ValidationBuilder) ValidateURL(config map[string]any, field string) *ValidationBuilder

+ type ValidationError struct

+ Code string

+ Field string

+ Message string

+ type ValidationErrorProto struct

+ Code string

+ Field string

+ Message string

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