Skip to content

Commit

Permalink
Add gatewayd plugin scaffold CLI docs (#528)
Browse files Browse the repository at this point in the history
* Add plugin scaffold CLI docs
* Add sleep to prevent stop from starting sooner than start
  • Loading branch information
mostafa authored May 11, 2024
1 parent 1709235 commit 51bb3a4
Show file tree
Hide file tree
Showing 18 changed files with 39 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/gatewayd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_config_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_config_lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion docs/gatewayd_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_plugin_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_plugin_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_plugin_lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_plugin_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
21 changes: 21 additions & 0 deletions docs/gatewayd_plugin_scaffold.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/gatewayd_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions metrics/merger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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()
}

0 comments on commit 51bb3a4

Please sign in to comment.