Add gatewayd plugin scaffold CLI docs (#528)

mostafa · web-flow · commit 51bb3a48edd7 · 2024-05-11T23:19:18.000+02:00
* Add plugin scaffold CLI docs
* Add sleep to prevent stop from starting sooner than start
diff --git a/docs/gatewayd.md b/docs/gatewayd.md
@@ -20,4 +20,4 @@ GatewayD is a cloud-native database gateway and framework for building data-driv
 * [gatewayd run](gatewayd_run.md)	 - Run a GatewayD instance
 * [gatewayd version](gatewayd_version.md)	 - Show version information
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_completion.md b/docs/gatewayd_completion.md
@@ -22,4 +22,4 @@ See each sub-command's help for details on how to use the generated script.
 * [gatewayd completion powershell](gatewayd_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [gatewayd completion zsh](gatewayd_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_completion_bash.md b/docs/gatewayd_completion_bash.md
@@ -41,4 +41,4 @@ gatewayd completion bash
 
 * [gatewayd completion](gatewayd_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_completion_fish.md b/docs/gatewayd_completion_fish.md
@@ -32,4 +32,4 @@ gatewayd completion fish [flags]
 
 * [gatewayd completion](gatewayd_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_completion_powershell.md b/docs/gatewayd_completion_powershell.md
@@ -29,4 +29,4 @@ gatewayd completion powershell [flags]
 
 * [gatewayd completion](gatewayd_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_completion_zsh.md b/docs/gatewayd_completion_zsh.md
@@ -43,4 +43,4 @@ gatewayd completion zsh [flags]
 
 * [gatewayd completion](gatewayd_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_config.md b/docs/gatewayd_config.md
@@ -18,4 +18,4 @@ gatewayd config [flags]
 * [gatewayd config init](gatewayd_config_init.md)	 - Create or overwrite the GatewayD global config
 * [gatewayd config lint](gatewayd_config_lint.md)	 - Lint the GatewayD global config
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_config_init.md b/docs/gatewayd_config_init.md
@@ -19,4 +19,4 @@ gatewayd config init [flags]
 
 * [gatewayd config](gatewayd_config.md)	 - Manage GatewayD global configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_config_lint.md b/docs/gatewayd_config_lint.md
@@ -18,4 +18,4 @@ gatewayd config lint [flags]
 
 * [gatewayd config](gatewayd_config.md)	 - Manage GatewayD global configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin.md b/docs/gatewayd_plugin.md
@@ -19,5 +19,6 @@ gatewayd plugin [flags]
 * [gatewayd plugin install](gatewayd_plugin_install.md)	 - Install a plugin from a local archive or a GitHub repository
 * [gatewayd plugin lint](gatewayd_plugin_lint.md)	 - Lint the GatewayD plugins config
 * [gatewayd plugin list](gatewayd_plugin_list.md)	 - List the GatewayD plugins
+* [gatewayd plugin scaffold](gatewayd_plugin_scaffold.md)	 - Scaffold a plugin and store the files into a directory
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin_init.md b/docs/gatewayd_plugin_init.md
@@ -19,4 +19,4 @@ gatewayd plugin init [flags]
 
 * [gatewayd plugin](gatewayd_plugin.md)	 - Manage plugins and their configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin_install.md b/docs/gatewayd_plugin_install.md
@@ -33,4 +33,4 @@ gatewayd plugin install [flags]
 
 * [gatewayd plugin](gatewayd_plugin.md)	 - Manage plugins and their configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin_lint.md b/docs/gatewayd_plugin_lint.md
@@ -18,4 +18,4 @@ gatewayd plugin lint [flags]
 
 * [gatewayd plugin](gatewayd_plugin.md)	 - Manage plugins and their configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin_list.md b/docs/gatewayd_plugin_list.md
@@ -19,4 +19,4 @@ gatewayd plugin list [flags]
 
 * [gatewayd plugin](gatewayd_plugin.md)	 - Manage plugins and their configuration
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_plugin_scaffold.md b/docs/gatewayd_plugin_scaffold.md
@@ -0,0 +1,21 @@
+## gatewayd plugin scaffold
+
+Scaffold a plugin and store the files into a directory
+
+```
+gatewayd plugin scaffold [flags]
+```
+
+### Options
+
+```
+  -h, --help                help for scaffold
+  -i, --input-file string   Plugin scaffold input file (default "input.yaml")
+  -o, --output-dir string   Output directory for the scaffold (default "./plugins")
+```
+
+### SEE ALSO
+
+* [gatewayd plugin](gatewayd_plugin.md)	 - Manage plugins and their configuration
+
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_run.md b/docs/gatewayd_run.md
@@ -24,4 +24,4 @@ gatewayd run [flags]
 
 * [gatewayd](gatewayd.md)	 - A cloud-native database gateway and framework for building data-driven applications
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/docs/gatewayd_version.md b/docs/gatewayd_version.md
@@ -16,4 +16,4 @@ gatewayd version [flags]
 
 * [gatewayd](gatewayd.md)	 - A cloud-native database gateway and framework for building data-driven applications
 
-###### Auto generated by spf13/cobra on 8-Mar-2024
+###### Auto generated by spf13/cobra on 10-May-2024
diff --git a/metrics/merger_test.go b/metrics/merger_test.go
@@ -60,5 +60,6 @@ gatewayd_test_total{plugin="test"} 1`
 
 	// Test start/stop of the merger scheduler.
 	go merger.Start()
+	time.Sleep(time.Second)
 	go merger.Stop()
 }

Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@ gatewayd completion bash`
`41`	`41`
`42`	`42`	`* [gatewayd completion](gatewayd_completion.md) - Generate the autocompletion script for the specified shell`
`43`	`43`
`44`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`44`	`+###### Auto generated by spf13/cobra on 10-May-2024`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,4 @@ gatewayd completion fish [flags]`
`32`	`32`
`33`	`33`	`* [gatewayd completion](gatewayd_completion.md) - Generate the autocompletion script for the specified shell`
`34`	`34`
`35`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`35`	`+###### Auto generated by spf13/cobra on 10-May-2024`
Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,4 @@ gatewayd completion powershell [flags]`
`29`	`29`
`30`	`30`	`* [gatewayd completion](gatewayd_completion.md) - Generate the autocompletion script for the specified shell`
`31`	`31`
`32`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`32`	`+###### Auto generated by spf13/cobra on 10-May-2024`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,4 @@ gatewayd completion zsh [flags]`
`43`	`43`
`44`	`44`	`* [gatewayd completion](gatewayd_completion.md) - Generate the autocompletion script for the specified shell`
`45`	`45`
`46`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`46`	`+###### Auto generated by spf13/cobra on 10-May-2024`
Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,4 @@ gatewayd config init [flags]`
`19`	`19`
`20`	`20`	`* [gatewayd config](gatewayd_config.md) - Manage GatewayD global configuration`
`21`	`21`
`22`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`22`	`+###### Auto generated by spf13/cobra on 10-May-2024`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,4 @@ gatewayd config lint [flags]`
`18`	`18`
`19`	`19`	`* [gatewayd config](gatewayd_config.md) - Manage GatewayD global configuration`
`20`	`20`
`21`		`-###### Auto generated by spf13/cobra on 8-Mar-2024`
	`21`	`+###### Auto generated by spf13/cobra on 10-May-2024`