feat(datawarehouse): add datawarehouse support#5294
feat(datawarehouse): add datawarehouse support#5294remyleone merged 1 commit intoscaleway:masterfrom
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #5294 +/- ##
==========================================
- Coverage 55.88% 55.88% -0.01%
==========================================
Files 316 317 +1
Lines 71631 71636 +5
==========================================
Hits 40032 40032
- Misses 30104 30109 +5
Partials 1495 1495 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds Scaleway Data Warehouse (scw datawarehouse) support to the CLI, including command registration, generated documentation, and updated usage fixtures.
Changes:
- Register the new
datawarehousenamespace and place it under thedatabasecommand group. - Add autogenerated command documentation for
scw datawarehouse. - Add/update CLI usage golden test fixtures for
datawarehousecommands.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/namespaces/datawarehouse/v1beta1/custom.go | Wires generated Data Warehouse commands into the CLI and assigns the database group. |
| docs/commands/datawarehouse.md | Adds autogenerated markdown docs for scw datawarehouse and subcommands. |
| commands/commands.go | Registers datawarehouse.GetCommands() in the global CLI command set. |
| cmd/scw/testdata/test-main-usage-usage.golden | Updates top-level CLI usage output to include datawarehouse under DATABASE COMMANDS. |
| cmd/scw/testdata/test-all-usage-datawarehouse-usage.golden | Adds golden output for scw datawarehouse help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-database-usage.golden | Adds golden output for scw datawarehouse database help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-database-create-usage.golden | Adds golden output for scw datawarehouse database create help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-database-delete-usage.golden | Adds golden output for scw datawarehouse database delete help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-database-list-usage.golden | Adds golden output for scw datawarehouse database list help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-usage.golden | Adds golden output for scw datawarehouse deployment help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-create-usage.golden | Adds golden output for scw datawarehouse deployment create help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-delete-usage.golden | Adds golden output for scw datawarehouse deployment delete help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-get-usage.golden | Adds golden output for scw datawarehouse deployment get help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-list-usage.golden | Adds golden output for scw datawarehouse deployment list help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-deployment-update-usage.golden | Adds golden output for scw datawarehouse deployment update help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-endpoint-usage.golden | Adds golden output for scw datawarehouse endpoint help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-preset-usage.golden | Adds golden output for scw datawarehouse preset help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-preset-list-usage.golden | Adds golden output for scw datawarehouse preset list help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-user-usage.golden | Adds golden output for scw datawarehouse user help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-user-create-usage.golden | Adds golden output for scw datawarehouse user create help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-user-delete-usage.golden | Adds golden output for scw datawarehouse user delete help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-user-list-usage.golden | Adds golden output for scw datawarehouse user list help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-user-update-usage.golden | Adds golden output for scw datawarehouse user update help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-version-usage.golden | Adds golden output for scw datawarehouse version help. |
| cmd/scw/testdata/test-all-usage-datawarehouse-version-list-usage.golden | Adds golden output for scw datawarehouse version list help. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| func GetCommands() *core.Commands { | ||
| cmds := GetGeneratedCommands() | ||
|
|
||
| cmds.MustFind("datawarehouse").Groups = []string{"database"} |
There was a problem hiding this comment.
The CLI exposes a top-level datawarehouse endpoint command, but it has no subcommands and no action (it only shows help). If endpoint operations aren't supported yet, consider hiding this command (cmd.Hidden = true) until real endpoint verbs exist, to avoid shipping a non-functional surface area.
| cmds.MustFind("datawarehouse").Groups = []string{"database"} | |
| cmds.MustFind("datawarehouse").Groups = []string{"database"} | |
| cmds.MustFind("datawarehouse", "endpoint").Hidden = true |
| Manage endpoints associated with a deployment. | ||
|
|
There was a problem hiding this comment.
The Endpoint section repeats the same description twice, which looks like a doc-gen artifact and makes the rendered docs noisy. Please remove the duplicate sentence (or adjust the doc generator/template so it only renders the section description once).
| Manage endpoints associated with a deployment. |
|
|
||
|
|
||
|
|
||
| ## List available Clickhouse® versions |
There was a problem hiding this comment.
The heading uses "Clickhouse®" (lowercase 'h'), while the product branding elsewhere (including the subsection title right below) uses "ClickHouse®". Please standardize the title/TOC entry to "ClickHouse®" by fixing the source command metadata so regenerated docs and help output are consistent.
| ## List available Clickhouse® versions | |
| ## List available ClickHouse® versions |
| cmds := GetGeneratedCommands() | ||
|
|
||
| cmds.MustFind("datawarehouse").Groups = []string{"database"} | ||
|
|
There was a problem hiding this comment.
The "preset" and "version" resource commands currently have the same Short text as their only subcommand ("list"), which produces duplicated entries/headings in generated docs (and makes the help output less clear). Consider overriding the resource command Short values in this custom.go to follow the established pattern (e.g. "Preset management commands" / "ClickHouse® version management commands"), so the leaf command keeps the "List ..." wording.
| // Override resource command Short descriptions to avoid duplication with their subcommands. | |
| cmds.MustFind("datawarehouse", "preset").Short = "Preset management commands" | |
| cmds.MustFind("datawarehouse", "version").Short = "ClickHouse® version management commands" |
Community Note
Relates OR Closes #0000
Release note for CHANGELOG: