Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better skaffold help output #1580

Closed
dgageot opened this issue Feb 1, 2019 · 1 comment
Closed

Better skaffold help output #1580

dgageot opened this issue Feb 1, 2019 · 1 comment
Assignees
Labels
good first issue Good for newcomers help wanted We would love to have this done, but don't have the bandwidth, need help from contributors kind/documentation kind/feature-request

Comments

@dgageot
Copy link
Contributor

dgageot commented Feb 1, 2019

skaffold help says:

A tool that facilitates continuous development for Kubernetes applications.

Usage:
  skaffold [command]

Available Commands:
  build       Builds the artifacts
  completion  Output skaffold shell completion for the given shell (bash or zsh)
  config      A set of commands for interacting with the skaffold config.
  delete      Delete the deployed resources
  deploy      Deploys the artifacts
  dev         Runs a pipeline file in development mode
  diagnose    Run a diagnostic on Skaffold
  fix         Converts old skaffold.yaml to newest schema version
  help        Help about any command
  init        Automatically generate skaffold configuration for deploying an application
  run         Runs a pipeline file
  version     Print the version information

Flags:
  -h, --help               help for skaffold
  -v, --verbosity string   Log level (debug, info, warn, error, fatal, panic) (default "warning")

Use "skaffold [command] --help" for more information about a command.```

Our doc says:

End-to-end pipelines:
 + skaffold run - to build & deploy once
 + skaffold dev - to trigger the watch loop build & deploy workflow with cleanup on exit

Pipeline building blocks for CI/CD:
 + skaffold build - to just build and tag your image(s)
 + skaffold deploy - to deploy the given image(s)
 + skaffold delete - to cleanup the deployed artifacts

Getting started with a new project:
 + skaffold init - to bootstrap skaffold.yaml
 + skaffold fix - to upgrade from

Utilities:
 + skaffold help - print help
 + skaffold version - get Skaffold version
 + skaffold completion - setup tab completion for the CLI
 + skaffold config - manage context specific parameters
 + skaffold diagnose - diagnostics of skaffold works in your project

I think it would be nice to organize the output of skaffold help like our documentation.
By default, cobra can't manage command groups but it should be possible to twist his arm like kubectl does.

@balopat balopat added good first issue Good for newcomers help wanted We would love to have this done, but don't have the bandwidth, need help from contributors labels Apr 9, 2019
@dgageot
Copy link
Contributor Author

dgageot commented Jul 28, 2019

This was fixed by #2324

@dgageot dgageot closed this as completed Jul 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted We would love to have this done, but don't have the bandwidth, need help from contributors kind/documentation kind/feature-request
Projects
None yet
Development

No branches or pull requests

3 participants