info

Documentation

Index

• Constants
• Variables
• func AllHookArguments() []string
• func GetNativeHooks() []string
• func GetValidHooks() []string
• func GetVirtualHooks() []string
• func HookArguments(hook string) []string
• func VirtualHook(hook string) (string, bool)

Constants

const (
	ActionSucceeded = 0
	ActionSkipped   = 1
	ActionFailed    = 2
)

const (
	Version              = "1.4.0"
	ReleaseDate          = "2025-07-25"
	Config               = "captainhook.json"
	MinRequiredInstaller = "1.0.4"
	Executable           = "captainhook"
)

const (
	ArgCommitMsgFile = "message-file"
	ArgGitCommand    = "git-command"
	ArgHash          = "hash"
	ArgPreviousHead  = "previous-hash"
	ArgMode          = "mode"
	ArgNewHead       = "new-head"
	ArgSquash        = "squash"
	ArgTarget        = "target"
	ArgURL           = "url"
	ArgCommand       = "command"
)

Names of all hook arguments to map them from position to name

const (
	PreCommit        = "pre-commit"
	PrePush          = "pre-push"
	CommitMsg        = "commit-msg"
	PrepareCommitMsg = "prepare-commit-msg"
	PostCommit       = "post-commit"
	PostMerge        = "post-merge"
	PostCheckout     = "post-checkout"
	PostRewrite      = "post-rewrite"
	PostChange       = "post-change"
)

Variables

var (
	HookArgs = map[string][]string{
		CommitMsg:        {ArgCommitMsgFile},
		PostCheckout:     {ArgPreviousHead, ArgNewHead, ArgMode},
		PostCommit:       {},
		PostMerge:        {ArgSquash},
		PostRewrite:      {ArgGitCommand},
		PreCommit:        {},
		PrePush:          {ArgTarget, ArgURL},
		PrepareCommitMsg: {ArgCommitMsgFile, ArgMode, ArgHash},
	}
)

Functions

func AllHookArguments

func AllHookArguments() []string

AllHookArguments returns a slice of all available arguments It is used to detect if a placeholder config is correct

func GetNativeHooks

func GetNativeHooks() []string

GetNativeHooks is returning all hooks native to git

func GetValidHooks

func GetValidHooks() []string

GetValidHooks is returning all hooks supported by CaptainHook git native and virtual ones.

func GetVirtualHooks

func GetVirtualHooks() []string

GetVirtualHooks is retuning all virtual hooks provided by CaptainHook

func HookArguments

func HookArguments(hook string) []string

HookArguments returns the arguments for a given hook

func VirtualHook

func VirtualHook(hook string) (string, bool)

VirtualHook returns the virtual hook triggered by a given native hook Examples: - post-checkout triggers post-change - post-merge triggers post-change ...