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

init --help should shows the plugins and project versions available #1913

Closed
camilamacedo86 opened this issue Dec 17, 2020 · 4 comments · Fixed by #1937
Closed

init --help should shows the plugins and project versions available #1913

camilamacedo86 opened this issue Dec 17, 2020 · 4 comments · Fixed by #1937
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@camilamacedo86
Copy link
Member

camilamacedo86 commented Dec 17, 2020

What do you want to happen?

I'd like to see the project versions and plugins when I the command kubebuilder init --help is executed. Otherwise, it is hard to know the values.

 $ kubebuilder init --help
Usage of base:
      --plugins string           plugins to run
      --project-version string   project version
pflag: help requested

@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 17, 2020
@camilamacedo86 camilamacedo86 changed the title init --help should shows the plugins and project versions available to make its easier init --help should shows the plugins and project versions available Dec 17, 2020
@camilamacedo86 camilamacedo86 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Jan 12, 2021
@camilamacedo86
Copy link
Member Author

the PR #1937 should fix that as well.

@Adirio
Copy link
Contributor

Adirio commented Jan 13, 2021

With #1937, the output to kubebuilder init --help is:

Initialize a new project including vendor/ directory and Go package directories.

Writes the following files:
- a boilerplate license file
- a PROJECT file with the domain and repo
- a Makefile to build the project
- a go.mod with project dependencies
- a Kustomization.yaml for customizating manifests
- a Patch file for customizing image for manager manifests
- a Patch file for enabling prometheus metrics
- a main.go to run

project will prompt the user to run 'dep ensure' after writing the project files.

Usage:
  kubebuilder init [flags]

Examples:
  # Scaffold a project using the apache2 license with "The Kubernetes authors" as owners
  kubebuilder init --project-version=2 --domain example.org --license apache2 --owner "The Kubernetes authors"


Flags:
      --component-config         create a versioned ComponentConfig file, may be 'true' or 'false'
      --domain string            domain for groups (default "my.domain")
      --fetch-deps               ensure dependencies are downloaded (default true)
  -h, --help                     help for init
      --license string           license to use to boilerplate, may be one of 'apache2', 'none' (default "apache2")
      --owner string             owner to add to the copyright
      --plugins strings          Name and optionally version of the plugin to initialize the project with. Available plugins: ("go.kubebuilder.io/v2", "go.kubebuilder.io/v3")
      --project-name string      name of this project
      --project-version string   project version, possible values: ("2", "3-alpha") (default "3-alpha")
      --repo string              name to use for go module (e.g., github.com/user/repo), defaults to the go package of the current working directory.
      --skip-go-version-check    if specified, skip checking the Go version

Should this be enough? Any suggested changes?

@camilamacedo86
Copy link
Member Author

Yes, it is. get my attention the statement project will prompt the user to run 'dep ensure' after writing the project files.. I do not think that we should have that any more. however, it is another bug.

@Adirio
Copy link
Contributor

Adirio commented Jan 13, 2021

Yeah, we should re-visit the descriptions and examples for all commands.

Rebased so the dep part is removed (#1945)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants