Skip to content

mark alpha command as experimental - #10170

Merged
ndeloof merged 1 commit into
docker:v2from
ndeloof:experimental_annotations
Jan 12, 2023
Merged

ndeloof merged 1 commit into
docker:v2from
ndeloof:experimental_annotations

Conversation

@ndeloof

@ndeloof ndeloof commented Jan 12, 2023

Copy link
Copy Markdown
Contributor

Mark experimental CLI commands with annotation so docs will reflect it
based on @thaJeztah comment #10163 (review)

@ndeloof
ndeloof requested review from a team, StefanScherer, glours, laurazard, milas, nicksieger and ulyssessouza and removed request for a team January 12, 2023 13:04

@glours glours left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ‘Œ

Comment thread cmd/compose/alpha.go Outdated
Use: "alpha [COMMAND]",
Hidden: true,
Annotations: map[string]string{
"experimental": "true",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread cmd/compose/watch.go Outdated
return runWatch(ctx, backend, opts, args)
}),
ValidArgsFunction: completeServiceNames(p),
Annotations: map[string]string{

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
ndeloof force-pushed the experimental_annotations branch from 3c209f3 to f429fa8 Compare January 12, 2023 13:32
@codecov

codecov Bot commented Jan 12, 2023

Copy link
Copy Markdown

Codecov Report

❗ No coverage uploaded for pull request base (v2@db267d8). Click here to learn what that means.
Patch has no changes to coverable lines.

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.
πŸ“’ Do you have feedback about the report comment? Let us know in this issue.

@ndeloof
ndeloof merged commit 8c07fa4 into docker:v2 Jan 12, 2023
@ndeloof
ndeloof deleted the experimental_annotations branch January 12, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants