Skip to content

fix: include the top level app command with sub commands in help page examples #93

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

Merged
zimeg merged 5 commits into from
May 15, 2025
Merged

fix: include the top level app command with sub commands in help page examples #93

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5d2d15d
fix: include the top level app command for unaliased sub commads link…
zimeg May 14, 2025
cce6e06
chore: mark the deprecated workspace alias as deprecated in comment
zimeg May 14, 2025
09821a2
Merge branch 'main' into zimeg-fix-app-command-examples
mwbrooks May 14, 2025
7964827
chore: merge w main
zimeg May 15, 2025
eafdabb
docs: include the top app portion for subcommands in examples
zimeg May 15, 2025
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
11 changes: 6 additions & 5 deletions cmd/app/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
Short: "Install, uninstall, and list teams with the app installed",
Long: "Install, uninstall, and list teams with the app installed",
Example: style.ExampleCommandsf([]style.ExampleCommand{
{Command: "install", Meaning: "Install a production app to a team"},
{Command: "link", Meaning: "Link an existing app to the project"},
{Command: "list", Meaning: "List all teams with the app installed"},
{Command: "uninstall", Meaning: "Uninstall an app from a team"},
{Command: "delete", Meaning: "Delete an app and app info from a team"},
{Command: "app install", Meaning: "Install a production app to a team"},
{Command: "app link", Meaning: "Link an existing app to the project"},
{Command: "app list", Meaning: "List all teams with the app installed"},
{Command: "app uninstall", Meaning: "Uninstall an app from a team"},
{Command: "app delete", Meaning: "Delete an app and app info from a team"},
}),
Args: cobra.NoArgs,
PreRunE: func(cmd *cobra.Command, args []string) error {
Expand All @@ -47,6 +47,7 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
},
PostRunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
// DEPRECATED(semver:major): remove the "workspace" alias
Copy link
Member Author

@zimeg zimeg May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📣 Wanting to call this change out! This matches deprecations that we might hope to search for in the next set of breaking changes.

if cmd.CalledAs() == "workspace" {
clients.IO.PrintInfo(ctx, false, fmt.Sprintf(
"\n%s It looks like you used %s. This command will be deprecated in an upcoming release.\n You can now use %s instead of %s.\n ",
Expand Down
Loading