mark alpha command as experimental #10170
Conversation
ndeloof
requested review from
a team,
nicksieger,
StefanScherer,
ulyssessouza,
glours,
milas and
laurazard
and removed request for
a team
cmd/compose/alpha.go
Outdated
| @@ -25,6 +25,10 @@ func alphaCommand(p *ProjectOptions, backend api.Service) *cobra.Command { | |||
| Short: "Experimental commands", | |||
| Use: "alpha [COMMAND]", | |||
| Hidden: true, | |||
| Annotations: map[string]string{ | |||
| "experimental": "true", | |||
There was a problem hiding this comment.
I think we only need the experimentalCLI part, as this one may (not sure if that's implemented in compose) hide the command based on whether the daemon has experimental features enabled.
cmd/compose/watch.go
Outdated
| @@ -44,6 +44,10 @@ func watchCommand(p *ProjectOptions, backend api.Service) *cobra.Command { | |||
| return runWatch(ctx, backend, opts, args) | |||
| }), | |||
| ValidArgsFunction: completeServiceNames(p), | |||
| Annotations: map[string]string{ | |||
There was a problem hiding this comment.
If "watch" is a subcommand of "alpha", then probably this isn't needed (but double check if I'm right); IIRC, we make the YAMLdocs check if parents are experimental, and make child-commands inherit that.
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
ndeloof
force-pushed
the
experimental_annotations
branch
from
3c209f3 to
f429fa8
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## v2 #10170 +/- ##
=====================================
Coverage ? 73.89%
=====================================
Files ? 2
Lines ? 272
Branches ? 0
=====================================
Hits ? 201
Misses ? 60
Partials ? 11 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Mark experimental CLI commands with annotation so docs will reflect it
based on @thaJeztah comment #10163 (review)