From 1c5d6d63579c1e9d7a8bc903d48471939681f8d5 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Wed, 29 Sep 2021 22:36:43 +0200 Subject: [PATCH] docs: attempt some cmd docs --- cli/recipe/release.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/cli/recipe/release.go b/cli/recipe/release.go index d9e36396e..a1a1a608b 100644 --- a/cli/recipe/release.go +++ b/cli/recipe/release.go @@ -78,6 +78,27 @@ var recipeReleaseCommand = &cli.Command{ Usage: "tag a recipe", Aliases: []string{"rl"}, ArgsUsage: " []", + Description: ` +This command is used to specify a new tag for a recipe. These tags are used to +identify different versions of the recipe and are published on the Co-op Cloud +recipe catalogue. + +These tags take the following form: + + a.b.c+x.y.z + +Where the "a.b.c" part is maintained as a semantic version of the recipe by the +recipe maintainer. And the "x.y.z" part is the image tag of the recipe "app" +service (the main container which contains the software to be used). + +We maintain a semantic versioning scheme ("a.b.c") alongside the libre app +versioning scheme in order to maximise the chances that the nature of recipe +updates are properly communicated. + +Abra does its best to read the "a.b.c" version scheme and communicate what +action needs to be taken when performing different operations such as an update +or a rollback of an app. +`, Flags: []cli.Flag{ DryFlag, PatchFlag,