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.

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

gencomponentdocs support module all to generate all karmada components docs #6184

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

gencomponentdocs support module all to generate all karmada components docs #6184

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
66 changes: 43 additions & 23 deletions hack/tools/gencomponentdocs/gen_component_docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,50 +55,70 @@ func main() {
os.Exit(1)
}

var cmd *cobra.Command
cmds, err := generateCMDs(module)
if err != nil {
fmt.Fprint(os.Stderr, err.Error())
os.Exit(1)
}

for _, cmd := range cmds {
cmd.DisableAutoGenTag = true
err = doc.GenMarkdownTree(cmd, outDir)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to generate docs: %v\n", err)
os.Exit(1)
}
err = MarkdownPostProcessing(cmd, outDir, cleanupForInclude)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to cleanup docs: %v\n", err)
os.Exit(1)
}
}
}

func generateCMDs(module string) ([]*cobra.Command, error) {
var cmds []*cobra.Command
switch module {
case names.KarmadaControllerManagerComponentName:
// generate docs for karmada-controller-manager
cmd = cmapp.NewControllerManagerCommand(context.TODO())
cmds = append(cmds, cmapp.NewControllerManagerCommand(context.TODO()))
case names.KarmadaSchedulerComponentName:
// generate docs for karmada-scheduler
cmd = schapp.NewSchedulerCommand(nil)
cmds = append(cmds, schapp.NewSchedulerCommand(nil))
case names.KarmadaAgentComponentName:
// generate docs for karmada-agent
cmd = agentapp.NewAgentCommand(context.TODO())
cmds = append(cmds, agentapp.NewAgentCommand(context.TODO()))
case names.KarmadaAggregatedAPIServerComponentName:
// generate docs for karmada-aggregated-apiserver
cmd = aaapp.NewAggregatedApiserverCommand(context.TODO())
cmds = append(cmds, aaapp.NewAggregatedApiserverCommand(context.TODO()))
case names.KarmadaDeschedulerComponentName:
// generate docs for karmada-descheduler
cmd = deschapp.NewDeschedulerCommand(nil)
cmds = append(cmds, deschapp.NewDeschedulerCommand(nil))
case names.KarmadaSearchComponentName:
// generate docs for karmada-search
cmd = searchapp.NewKarmadaSearchCommand(context.TODO())
cmds = append(cmds, searchapp.NewKarmadaSearchCommand(context.TODO()))
case names.KarmadaSchedulerEstimatorComponentName:
// generate docs for karmada-scheduler-estimator
cmd = estiapp.NewSchedulerEstimatorCommand(context.TODO())
cmds = append(cmds, estiapp.NewSchedulerEstimatorCommand(context.TODO()))
case names.KarmadaWebhookComponentName:
// generate docs for karmada-webhook
cmd = webhookapp.NewWebhookCommand(context.TODO())
cmds = append(cmds, webhookapp.NewWebhookCommand(context.TODO()))
case names.KarmadaMetricsAdapterComponentName:
// generate docs for karmada-metrics-adapter
cmd = adapterapp.NewMetricsAdapterCommand(context.TODO())
cmds = append(cmds, adapterapp.NewMetricsAdapterCommand(context.TODO()))
case "all":
cmds = append(cmds, cmapp.NewControllerManagerCommand(context.TODO()))
cmds = append(cmds, schapp.NewSchedulerCommand(nil))
cmds = append(cmds, agentapp.NewAgentCommand(context.TODO()))
cmds = append(cmds, aaapp.NewAggregatedApiserverCommand(context.TODO()))
cmds = append(cmds, deschapp.NewDeschedulerCommand(nil))
cmds = append(cmds, searchapp.NewKarmadaSearchCommand(context.TODO()))
cmds = append(cmds, estiapp.NewSchedulerEstimatorCommand(context.TODO()))
cmds = append(cmds, webhookapp.NewWebhookCommand(context.TODO()))
cmds = append(cmds, adapterapp.NewMetricsAdapterCommand(context.TODO()))
default:
fmt.Fprintf(os.Stderr, "Module %s is not supported", module)
os.Exit(1)
return nil, fmt.Errorf("Module %s is not supported", module)
}

cmd.DisableAutoGenTag = true
err = doc.GenMarkdownTree(cmd, outDir)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to generate docs: %v\n", err)
os.Exit(1)
}
err = MarkdownPostProcessing(cmd, outDir, cleanupForInclude)
if err != nil {
fmt.Fprintf(os.Stderr, "failed to cleanup docs: %v\n", err)
os.Exit(1)
}
return cmds, nil
}