Skip to content

( 📖 ) [WiP] Enhancements to CLI Help #5498

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.

Sign up for GitHub

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

Draft
cmallikarjunah wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −6
Draft

( 📖 ) [WiP] Enhancements to CLI Help #5498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions pkg/plugins/golang/v4/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,17 @@ type initSubcommand struct {
func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) {
p.commandName = cliMeta.CommandName

subcmdMeta.Description = `Initialize a new project including the following files:
- a "go.mod" with project dependencies
- a "PROJECT" file that stores project configuration
- a "Makefile" with several useful make targets for the project
- several YAML files for project deployment under the "config" directory
- a "cmd/main.go" file that creates the manager that will run the project controllers
subcmdMeta.Description = `Initialize a new project within the current directory.
Following files will be generated automatically:
- go.mod: Go module with project dependencies
- PROJECT: file that stores project configuration
- Makefile: provides useful make targets for the project
- config/: Kubernetes manifests for deployment
- cmd/main.go: controller manager entry point
- Dockerfile: build controller manager container image
- test/: unit tests for the project
- hack/: contains licensing boilerplate.


Required flags:
--domain: Domain for your APIs (e.g., example.org creates crew.example.org for API groups)
Expand Down