From 4b7741d8d7e2acf72803367b9119d8a0c5ff5a83 Mon Sep 17 00:00:00 2001 From: Dylan Ratcliffe Date: Tue, 23 Jul 2024 09:23:34 +0000 Subject: [PATCH] Improve ticket link documentation --- cmd/changes_submit_plan.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/changes_submit_plan.go b/cmd/changes_submit_plan.go index fa16a98d..426417de 100644 --- a/cmd/changes_submit_plan.go +++ b/cmd/changes_submit_plan.go @@ -340,7 +340,7 @@ func init() { submitPlanCmd.PersistentFlags().String("title", "", "Short title for this change. If this is not specified, overmind will try to come up with one for you.") submitPlanCmd.PersistentFlags().String("description", "", "Quick description of the change.") - submitPlanCmd.PersistentFlags().String("ticket-link", "*", "Link to the ticket for this change.") + submitPlanCmd.PersistentFlags().String("ticket-link", "*", "Link to the ticket for this change. Usually this would be the link to something like the pull request, since the CLI uses this as a unique identifier for the change, meaning that multiple runs with the same ticket link will update the same change.") submitPlanCmd.PersistentFlags().String("owner", "", "The owner of this change.") // submitPlanCmd.PersistentFlags().String("cc-emails", "", "A comma-separated list of emails to keep updated with the status of this change.")