feat: add TriggerHook

getstackhead · Sep 26, 2021 · 355437f · 355437f
1 parent 1e5a4a2
commit 355437f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,14 @@ import "github.com/getstackhead/pluginlib"
 type MyPlugin struct {
 }
 
+var PluginConfig = pluginlib.PluginConfig{
+	Name:        "Test",
+	Description: "This is an example StackHead Proxy plugin",
+	Version:     "0.0.0-dev",
+	Authors:     []string{"Your Name"},
+	PluginType:  pluginlib.PluginType.PROXY,
+}
+
 func (p MyPlugin) Setup() {
 	// implement software setup action
 }
@@ -22,14 +30,14 @@ func (p MyPlugin) Destroy(project pluginlib.Project) {
 	// implement project destroy action
 }
 
-func (p MyPlugin) HookPreTerraformPlan(project pluginlib.Project) {
-	// pre terraform plan hook (to be implemented)
+func (p MyPlugin) TriggerHook(hookName string, project pluginlib.Project) {
+	// triggered by hooks
 }
 
 // Export plugin to StackHead. Must be named "Plugin"!
 var Plugin MyPlugin
 ```
 
 ```shell
-go build -buildmode=plugin -o plugin_myplugin.so main.go
+go build -buildmode=plugin -o plugin.so main.go
 ```
diff --git a/example/main.go b/example/main.go
@@ -29,3 +29,7 @@ func (p MyPlugin) Destroy(project pluginlib.Project) {
 func (p MyPlugin) Setup() {
 	fmt.Println("Setup...")
 }
+
+func (p MyPlugin) TriggerHook(hookName string, project pluginlib.Project) {
+	fmt.Println("Hook " + hookName + " triggered for project " + project.Name + ".")
+}
diff --git a/example/plugin_myplugin.so → example/plugin.so b/example/plugin_myplugin.so → example/plugin.so
diff --git a/plugin.go b/plugin.go
@@ -8,6 +8,7 @@ type Plugin interface {
 	Setup()
 	Deploy(project Project)
 	Destroy(project Project)
+	TriggerHook(hookName string, project Project)
 }
 
 func LoadPlugin(path string) (Plugin, *PluginConfig, error) {