From 1c217b127b179b7c795ccd4b1eae9cdb72b40cc6 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Tue, 10 Aug 2021 08:34:11 +0200 Subject: [PATCH] docs: add recipe upgrade docs --- cli/recipe/recipe.go | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/cli/recipe/recipe.go b/cli/recipe/recipe.go index 853dc7d3..122e8e4e 100644 --- a/cli/recipe/recipe.go +++ b/cli/recipe/recipe.go @@ -151,8 +151,20 @@ var recipeCreateCommand = &cli.Command{ } var recipeUpgradeCommand = &cli.Command{ - Name: "upgrade", - Usage: "Upgrade recipe image tags", + Name: "upgrade", + Usage: "Upgrade recipe image tags", + Description: ` +This command reads and attempts to parse all image tags within the given + configuration and prompt with more recent tags to upgrade to. It will +update the relevant compose file tags on the local file system. + +Some image tags cannot be parsed because they do not follow some sort of +semver-like convention. In this case, all possible tags will be listed and it +is up to the end-user to decide. + +This is step 1 of upgrading a recipe. Step 2 is running "abra recipe sync +". +`, ArgsUsage: "", Action: func(c *cli.Context) error { recipe := c.Args().First()