docs: attempt some cmd docs

This commit is contained in:
decentral1se 2021-09-29 22:36:43 +02:00
parent 75bdd59585
commit 1c5d6d6357
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 21 additions and 0 deletions

View File

@ -78,6 +78,27 @@ var recipeReleaseCommand = &cli.Command{
Usage: "tag a recipe",
Aliases: []string{"rl"},
ArgsUsage: "<recipe> [<tag>]",
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,