From 065e60091a9858bd06601ee4cbd83d8468060bb9 Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Wed, 21 Feb 2024 14:00:07 -0800 Subject: [PATCH] fixup: Add more long help text --- .../commands/waypoint/actionconfig/action_config.go | 12 ++++++++++-- internal/commands/waypoint/actionconfig/show.go | 2 +- internal/commands/waypoint/waypoint.go | 5 +++-- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/internal/commands/waypoint/actionconfig/action_config.go b/internal/commands/waypoint/actionconfig/action_config.go index cae01a69..5bceb0de 100644 --- a/internal/commands/waypoint/actionconfig/action_config.go +++ b/internal/commands/waypoint/actionconfig/action_config.go @@ -1,12 +1,20 @@ package actionconfig -import "github.com/hashicorp/hcp/internal/pkg/cmd" +import ( + "github.com/hashicorp/hcp/internal/pkg/cmd" + "github.com/hashicorp/hcp/internal/pkg/heredoc" +) func NewCmdActionConfig(ctx *cmd.Context) *cmd.Command { cmd := &cmd.Command{ Name: "action-config", ShortHelp: "Manage action configuration options for HCP Waypoint.", - LongHelp: "Manage action configuration options for HCP Waypoint.", + LongHelp: heredoc.New(ctx.IO).Must(` +Manage all action configuration options for HCP Waypoint. An action +configuration is a set of options that define how an action is executed. This +includes the action request type, and the action name. The action +configuration is used to launch action runs depending on the Request type. + `), } cmd.AddChild(NewCmdCreate(ctx)) diff --git a/internal/commands/waypoint/actionconfig/show.go b/internal/commands/waypoint/actionconfig/show.go index e7dc09f1..6d501fdd 100644 --- a/internal/commands/waypoint/actionconfig/show.go +++ b/internal/commands/waypoint/actionconfig/show.go @@ -68,7 +68,7 @@ func showActionConfig(c *cmd.Command, args []string, opts *ShowOpts) error { // latestRun := respPayload.LatestRun // totalRuns := respPayload.TotalRuns - // TODO(briancain): add a displayer.go + // TODO(briancain): https://github.com/hashicorp/hcp/issues/16 return nil } diff --git a/internal/commands/waypoint/waypoint.go b/internal/commands/waypoint/waypoint.go index 3a05ef79..eb967309 100644 --- a/internal/commands/waypoint/waypoint.go +++ b/internal/commands/waypoint/waypoint.go @@ -3,14 +3,15 @@ package waypoint import ( "github.com/hashicorp/hcp/internal/commands/waypoint/actionconfig" "github.com/hashicorp/hcp/internal/pkg/cmd" + "github.com/hashicorp/hcp/internal/pkg/heredoc" ) func NewCmdWaypoint(ctx *cmd.Context) *cmd.Command { cmd := &cmd.Command{ Name: "waypoint", ShortHelp: "Manage Waypoint.", - LongHelp: "Managing HCP Waypoint with CLI commands.", - Examples: []cmd.Example{}, + LongHelp: heredoc.New(ctx.IO).Must(`The {{ Bold "hcp waypoint" }} command group allows users to manage HCP Waypoint resources through the CLI. +These commands allow the user to interact with their HCP Waypoint instance to manage their application deployment process.`), } cmd.AddChild(actionconfig.NewCmdActionConfig(ctx))