From 51bb3a48edd783ff623234c8c34c4bfa335ae045 Mon Sep 17 00:00:00 2001 From: Mostafa Moradian Date: Sat, 11 May 2024 23:19:18 +0200 Subject: [PATCH] Add `gatewayd plugin scaffold` CLI docs (#528) * Add plugin scaffold CLI docs * Add sleep to prevent stop from starting sooner than start --- docs/gatewayd.md | 2 +- docs/gatewayd_completion.md | 2 +- docs/gatewayd_completion_bash.md | 2 +- docs/gatewayd_completion_fish.md | 2 +- docs/gatewayd_completion_powershell.md | 2 +- docs/gatewayd_completion_zsh.md | 2 +- docs/gatewayd_config.md | 2 +- docs/gatewayd_config_init.md | 2 +- docs/gatewayd_config_lint.md | 2 +- docs/gatewayd_plugin.md | 3 ++- docs/gatewayd_plugin_init.md | 2 +- docs/gatewayd_plugin_install.md | 2 +- docs/gatewayd_plugin_lint.md | 2 +- docs/gatewayd_plugin_list.md | 2 +- docs/gatewayd_plugin_scaffold.md | 21 +++++++++++++++++++++ docs/gatewayd_run.md | 2 +- docs/gatewayd_version.md | 2 +- metrics/merger_test.go | 1 + 18 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 docs/gatewayd_plugin_scaffold.md diff --git a/docs/gatewayd.md b/docs/gatewayd.md index 75adb466..0ed05a2b 100644 --- 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 index 24795e37..3c65eab6 100644 --- 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 index 308106b1..9378bd2f 100644 --- 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 index 102fec44..f9d22fb0 100644 --- 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 index 0c8b9e13..6d229ade 100644 --- 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 index 0bc3fd61..153b8697 100644 --- 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 index e77dc214..58298e7e 100644 --- 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 index d607b18f..2d96f6d6 100644 --- 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 index d2d9cb4b..1bf54152 100644 --- 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 index 49f6558e..4a987d3e 100644 --- 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 index adeaf28a..780707ad 100644 --- 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 index 31ab0619..5919068e 100644 --- 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 index 9333a6a3..ad4c90d2 100644 --- 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 index 39d43a1f..62062f44 100644 --- 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 new file mode 100644 index 00000000..2b93ef21 --- /dev/null +++ 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 index 326def3c..b3b6a324 100644 --- 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 index 133e62a0..412f3dec 100644 --- 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 index 0a107f23..0dc865bc 100644 --- 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() }