docs: add recipe upgrade docs

This commit is contained in:
decentral1se 2021-08-10 08:34:11 +02:00
parent 2028b9d7c7
commit 1c217b127b
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC

View File

@ -151,8 +151,20 @@ var recipeCreateCommand = &cli.Command{
} }
var recipeUpgradeCommand = &cli.Command{ var recipeUpgradeCommand = &cli.Command{
Name: "upgrade", Name: "upgrade",
Usage: "Upgrade recipe image tags", Usage: "Upgrade recipe image tags",
Description: `
This command reads and attempts to parse all image tags within the given
<recipe> 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
<recipe>".
`,
ArgsUsage: "<recipe>", ArgsUsage: "<recipe>",
Action: func(c *cli.Context) error { Action: func(c *cli.Context) error {
recipe := c.Args().First() recipe := c.Args().First()