diff --git a/docs/recipe-maintainer-guide.md b/docs/recipe-maintainer-guide.md index f37523a..8a9229f 100644 --- a/docs/recipe-maintainer-guide.md +++ b/docs/recipe-maintainer-guide.md @@ -89,6 +89,20 @@ The commands uses for dealing with this logic in `abra` are: - `abra recipe tag`: publish a git tag for the recipe repo - `abra recipe sync`: upgrade the deploy labels to match the new recipe version +## How to publish a new recipe version + +!!! warning + + Due to [a limitation](https://git.coopcloud.tech/coop-cloud/organising/issues/185) in the Git library we're using in `abra`, when tagging new releases, you **must** use annotated git tags (i.e. `git tag -a`) or `abra` won't be able to parse them correctly. On the up side, it is probably better to leave a message with your new Git tag anyway. So maybe this is just "best practice" ;) + +> This process is very much still a work in progress... + +- `abra recipe upgrade ` +- `abra recipe sync ` (where `` is your new Git tag) +- `git commit -m "chore: new release" .` +- `git tag -a && git push` +- `abra catalogue generate ` + ## Style guide - Please don't use `&image` YAML repeat anchors on the `image: ...` key because our `recipe release` logic does not handle it (see [#172](https://git.autonomic.zone/coop-cloud/abra/issues/172))